chore(docs): update code docs #294
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Deploy API Docs | |
| on: | |
| push: | |
| branches: [main] | |
| paths-ignore: | |
| - '.github/workflows/build.yml' | |
| - '.github/workflows/update.yml' | |
| - '.gitignore' | |
| - 'jsdoc.json' | |
| - 'LICENSE' | |
| - 'README.md' | |
| - 'renovate.json' | |
| workflow_dispatch: | |
| concurrency: | |
| group: deploy-api-docs | |
| cancel-in-progress: true | |
| permissions: | |
| contents: read | |
| jobs: | |
| deploy: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6 | |
| - name: Set up SSH | |
| env: | |
| DEPLOY_SSH_KEY: ${{ secrets.DEPLOY_SSH_KEY }} | |
| VPS_KNOWN_HOSTS: ${{ secrets.VPS_KNOWN_HOSTS }} | |
| run: | | |
| mkdir -p ~/.ssh | |
| chmod 700 ~/.ssh | |
| printf '%s\n' "$DEPLOY_SSH_KEY" > ~/.ssh/id_ed25519 | |
| chmod 600 ~/.ssh/id_ed25519 | |
| printf '%s\n' "$VPS_KNOWN_HOSTS" > ~/.ssh/known_hosts | |
| chmod 644 ~/.ssh/known_hosts | |
| - name: Deploy docs/ to VPS via rsync | |
| env: | |
| VPS_HOST: ${{ secrets.VPS_HOST }} | |
| VPS_USER: ${{ secrets.VPS_USER }} | |
| run: | | |
| rsync -avz --delete \ | |
| -e "ssh -i ~/.ssh/id_ed25519 -o StrictHostKeyChecking=yes" \ | |
| docs/ \ | |
| "${VPS_USER}@${VPS_HOST}:/opt/jellyrock/api-docs/" |