Merge pull request #347 from Nacho1499/feat/CLI-tool #12
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 SDK Docs | |
| on: | |
| push: | |
| branches: | |
| - master | |
| - main | |
| paths: | |
| - "sdk/src/**" | |
| - "sdk/typedoc.json" | |
| - "sdk/package.json" | |
| - "sdk/tsconfig.json" | |
| - ".github/workflows/docs.yml" | |
| # Allow manual trigger from the Actions tab | |
| workflow_dispatch: | |
| permissions: | |
| contents: read | |
| pages: write | |
| id-token: write | |
| # Only one deployment at a time; don't cancel in-progress runs | |
| concurrency: | |
| group: pages | |
| cancel-in-progress: false | |
| jobs: | |
| build: | |
| name: Build TypeDoc | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| - name: Setup Node.js | |
| uses: actions/setup-node@v4 | |
| with: | |
| node-version: "20" | |
| cache: "npm" | |
| cache-dependency-path: sdk/package-lock.json | |
| - name: Install SDK dependencies | |
| working-directory: sdk | |
| run: npm ci --ignore-scripts | |
| - name: Generate docs | |
| working-directory: sdk | |
| run: npm run docs | |
| - name: Upload Pages artifact | |
| uses: actions/upload-pages-artifact@v3 | |
| with: | |
| path: sdk/docs | |
| deploy: | |
| name: Deploy to GitHub Pages | |
| needs: build | |
| runs-on: ubuntu-latest | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| steps: | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@v4 |