This repository has been archived by the owner on Dec 12, 2024. It is now read-only.
Generates the HTML to publish to GH Pages #26
Workflow file for this run
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 Continuous Integration | |
| on: | |
| push: | |
| branches: | |
| - main | |
| pull_request: | |
| branches: | |
| - main | |
| # Allows you to run this workflow manually from the Actions tab | |
| workflow_dispatch: | |
| env: | |
| CI: true | |
| PNPM_CACHE_FOLDER: .pnpm-store | |
| jobs: | |
| tbdocs-reporter: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout source | |
| uses: actions/checkout@8e5e7e5ab8b370d6c329ec480221332ada57f0ab # v3.5.2 | |
| - name: install pnpm | |
| uses: pnpm/action-setup@v2 | |
| with: | |
| version: 8 | |
| - name: Set up Node.js | |
| uses: actions/setup-node@64ed1c7eab4cce3362f8c340dee64e5eaeef8f7c # v3.6.0 | |
| with: | |
| node-version: 20 | |
| registry-url: https://registry.npmjs.org/ | |
| - name: Install dependencies | |
| run: pnpm install | |
| - name: Build all workspace packages | |
| run: pnpm build | |
| - name: TBDocs Reporter | |
| id: tbdocs-reporter-protocol | |
| uses: TBD54566975/tbdocs@main | |
| with: | |
| group_docs: true | |
| entry_points: | | |
| - file: packages/protocol/src/main.ts | |
| docsReporter: api-extractor | |
| docsGenerator: typedoc-html | |
| - file: packages/http-client/src/main.ts | |
| docsReporter: api-extractor | |
| docsGenerator: typedoc-html | |
| - file: packages/http-server/src/main.ts | |
| docsReporter: api-extractor | |
| docsGenerator: typedoc-html | |
| - name: Upload documentation artifacts | |
| uses: actions/upload-artifact@a8a3f3ad30e3422c9c7b888a15615d19a852ae32 #v3.1.3 | |
| with: | |
| name: tbdocs-reporter-output | |
| path: ./.tbdocs |