API Documents #2502
Workflow file for this run
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: 'API Documents' | |
| on: | |
| push: | |
| branches: [main] | |
| pull_request: | |
| # The branches below must be a subset of the branches above | |
| branches: [main] | |
| permissions: | |
| contents: read | |
| jobs: | |
| gen_api_docs: | |
| name: Generate API documentation | |
| runs-on: ubuntu-latest | |
| steps: | |
| # actions/checkout@v4 | |
| - uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 | |
| # pnpm/action-setup@v6 | |
| - uses: pnpm/action-setup@0e279bb959325dab635dd2c09392533439d90093 | |
| with: | |
| version: 10 | |
| # actions/setup-node@v4 | |
| - uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 | |
| with: | |
| node-version: '22' | |
| cache: 'pnpm' | |
| - name: Install safe-chain | |
| run: curl -fsSL https://raw.githubusercontent.com/AikidoSec/safe-chain/6aec1bc4743028a99ab1ebace8e743549260ce82/install-scripts/install-safe-chain.sh | sh -s -- --ci | |
| - run: pnpm install --frozen-lockfile | |
| - run: pnpm doc | |
| # actions/upload-artifact@v4 | |
| - uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 | |
| with: | |
| name: Rhodonite-api-documents | |
| path: docs/api |