feat(docs): autogenerate API documentation #15468
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: Microsite | |
on: | |
# NOTE: If you change these you must update verify_microsite-noop.yml as well | |
pull_request: | |
paths: | |
- '.github/workflows/verify_microsite.yml' | |
- 'microsite/**' | |
- 'beps/**' | |
- 'mkdocs.yml' | |
- 'docs/**' | |
permissions: | |
contents: read | |
jobs: | |
build-microsite: | |
runs-on: ubuntu-latest | |
env: | |
CI: true | |
NODE_OPTIONS: --max-old-space-size=8192 | |
DOCUSAURUS_SSR_CONCURRENCY: 5 | |
name: Microsite | |
steps: | |
- name: Harden Runner | |
uses: step-security/harden-runner@0080882f6c36860b6ba35c610c98ce87d4e2f26f # v2.10.2 | |
with: | |
egress-policy: audit | |
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 | |
- name: Use Node.js 20.x | |
uses: actions/setup-node@39370e3970a6d050c480ffad4ff0ed4d3fdee5af # v4.1.0 | |
with: | |
node-version: 20.x | |
- uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b # v5 | |
with: | |
python-version: '3.9' | |
- name: Install MkDocs dependencies | |
run: pip install mkdocs mkdocs-techdocs-core | |
# Skip caching of microsite dependencies, it keeps the global cache size | |
# smaller, which make Windows builds a lot faster for the rest of the project. | |
- name: top-level install | |
run: yarn install --immutable | |
- name: yarn install | |
run: yarn install --immutable | |
working-directory: microsite | |
- name: build API reference | |
run: yarn build:api-docs | |
- name: Build MkDocs for TechDocs | |
run: mkdocs build --strict | |
- name: verify yarn dependency duplicates | |
run: node scripts/verify-lockfile-duplicates.js | |
- name: prettier | |
run: yarn prettier:check | |
working-directory: microsite | |
- name: build microsite | |
run: yarn build | |
working-directory: microsite |