Update readme #25
This file contains 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: Publish docs | |
| on: | |
| # Runs on pushes targeting the main branch | |
| push: | |
| branches: ['main'] | |
| # Allows you to run this workflow manually from the Actions tab | |
| workflow_dispatch: | |
| # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages | |
| permissions: | |
| contents: write | |
| pages: write | |
| id-token: write | |
| # Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued. | |
| # However, do NOT cancel in-progress runs as we want to allow these production deployments to complete. | |
| concurrency: | |
| group: 'pages' | |
| cancel-in-progress: false | |
| jobs: | |
| generate_and_commit_docs: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout docs branch | |
| uses: actions/checkout@v4 | |
| with: | |
| ref: 'docs' | |
| - name: Set account identity | |
| run: | | |
| git config --global user.email "[email protected]" | |
| git config --global user.name "Documentation Bot" | |
| - name: Rebase with main branch | |
| run: | | |
| git fetch | |
| git rebase -Xours origin/main | |
| - name: Install dependencies | |
| run: npm install | |
| - name: Generate docs for current version | |
| run: npm run docs-generate | |
| - name: Commit and Push Changes | |
| run: | | |
| git add docs/ | |
| git commit -m "Update docs (bot)" || echo "No changes (bot)" | |
| git push -f | |
| deploy_to_github_pages: | |
| needs: generate_and_commit_docs | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout docs branch | |
| uses: actions/checkout@v4 | |
| with: | |
| ref: 'docs' | |
| - name: Setup Pages | |
| uses: actions/configure-pages@v4 | |
| - name: Upload artifact | |
| uses: actions/upload-pages-artifact@v3 | |
| with: | |
| path: './docs' | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@v4 |