chore: update readme.md #324
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: "typedoc" | |
| on: | |
| push: | |
| branches: [main] | |
| pull_request: | |
| branches: [main] | |
| permissions: | |
| contents: read | |
| pages: write | |
| id-token: write | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: pnpm/action-setup@v2 | |
| with: | |
| version: 10.0.0 | |
| - name: Cache turbo | |
| uses: actions/cache@v3 | |
| with: | |
| path: | | |
| .turbo | |
| **/.turbo | |
| key: ${{ runner.os }}-turbo-${{ github.sha }} | |
| restore-keys: | | |
| ${{ runner.os }}-turbo- | |
| - name: Update Submodules | |
| run: git submodule update --init --recursive | |
| - name: Install Protobuf Compiler | |
| run: sudo apt-get install -y protobuf-compiler | |
| - name: Install dependencies | |
| run: pnpm install | |
| - name: Build dependencies | |
| run: pnpm run build:deps --ui stream | |
| - name: Build docs | |
| run: pnpm run docs | |
| - uses: actions/upload-pages-artifact@v3 | |
| with: | |
| path: ./docs | |
| deploy: | |
| if: ${{ github.ref == 'refs/heads/main' }} | |
| runs-on: ubuntu-latest | |
| environment: | |
| name: githubs | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| needs: build | |
| steps: | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| # https://github.com/actions/deploy-pages | |
| uses: actions/deploy-pages@v4 |