Update README.md #63
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
| # Simple workflow for deploying static content to GitHub Pages | |
| name: Deploy static content to Pages | |
| on: | |
| # do deploy to github pages on merge to main | |
| push: | |
| branches: | |
| - main | |
| # Allows you to run this workflow manually from the Actions tab | |
| workflow_dispatch: | |
| workflow_call: | |
| # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages | |
| permissions: | |
| contents: read | |
| 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: | |
| # Single deploy job since we're just deploying | |
| deploy: | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| runs-on: ubuntu-latest | |
| strategy: | |
| matrix: | |
| node-version: [18.14.0] | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| - name: Use Node.js ${{ matrix.node-version }} | |
| uses: actions/setup-node@v4 | |
| with: | |
| node-version: ${{ matrix.node-version }} | |
| - uses: pnpm/action-setup@v2 | |
| name: Install pnpm | |
| id: pnpm-install | |
| with: | |
| version: 8 | |
| run_install: false | |
| - name: Setup Pages | |
| uses: actions/configure-pages@v3 | |
| - name: Install dependencies | |
| run: | | |
| pnpm install; | |
| - name: Generate docs | |
| run: | | |
| cd packages/ts-sdk ; | |
| pnpm docs:generate; | |
| - name: Build SPA | |
| run: | | |
| cd packages/spa ; | |
| pnpm run build:deps ; | |
| pnpm run build ; | |
| - name: Convert symlinks to hard links | |
| # adapted from https://superuser.com/questions/560597/convert-symlinks-to-hard-links | |
| # we use symlinks for local dev & because they are committable to repo, | |
| # but hard links are needed for building tape archive to upload | |
| run: | | |
| cd docs ; | |
| ../scripts/link-docs.sh ; | |
| - name: Upload artifact | |
| uses: actions/upload-pages-artifact@v2 | |
| with: | |
| # Upload subdirectory | |
| path: './docs' | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@v2 |