Skip to content

ci: add CI job to test documentation build #1

ci: add CI job to test documentation build

ci: add CI job to test documentation build #1

name: Documentation Build

Check failure on line 1 in .github/workflows/documentation-build.yml

View workflow run for this annotation

GitHub Actions / .github/workflows/documentation-build.yml

Invalid workflow file

(Line: 7, Col: 5): A sequence was not expected, (Line: 12, Col: 5): A sequence was not expected
run-name: Ensure documentation can build successfully
on:
pull_request:
- main
- 'release-[0-9]+.[0-9]+.[0-9]+.[0-9]+'
- 'release-[0-9]+.[0-9]+.[0-9]+'
- 'release-[0-9]+.[0-9]+'
push:
- main
- 'release-[0-9]+.[0-9]+.[0-9]+.[0-9]+'
- 'release-[0-9]+.[0-9]+.[0-9]+'
- 'release-[0-9]+.[0-9]+'
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true
jobs:
docs-build:
name: Build Docs
runs-on: ubuntu-latest
defaults:
run:
working-directory: ./docs
steps:
- name: Checkout PR branch
uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6.0.0
with:
fetch-depth: 0
- name: Setup Node
uses: actions/setup-node@395ad3262231945c25e8478fd5baf05154b1d79f # v6.1.0
- name: Install dependencies
run: npm install
- name: Run gen-api-docs
run: npm run gen-api-docs all
- name: Build documentation
run: npm run build