docs: polish #1761
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: Docs | |
| on: | |
| push: | |
| # We only run this GitHub action upon new commits to `main` | |
| branches: | |
| - main | |
| # We only run this GitHub action if there are changes in the `docs/` directory | |
| paths: | |
| - docs/** | |
| jobs: | |
| build-and-deploy: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: pnpm/action-setup@v4 | |
| - run: pnpm install | |
| - run: pnpm run build | |
| - run: pnpm run docs:build | |
| - name: Deploy | |
| uses: JamesIves/[email protected] | |
| with: | |
| branch: gh-pages | |
| folder: docs/dist/client | |
| # Remove previous build files | |
| clean: true | |
| # Do not remove the `.nojekyll` file: we have manually added an empty `.nojekyll` file at the root of the `gh-pages` branch and we don't want having to re-create it after each build. | |
| clean-exclude: | | |
| .nojekyll | |
| permissions: | |
| contents: write |