Skip to content

Commit b159592

Browse files
ci: add CI job to test documentation build
we've hit issues previously where the docs have ended up in an unbuildable state this commit adds a CI job to prevent such regressions Signed-off-by: Nathan Weinberg <nweinber@redhat.com>
1 parent 5873a31 commit b159592

1 file changed

Lines changed: 44 additions & 0 deletions

File tree

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
name: Documentation Build
2+
3+
run-name: Ensure documentation can build successfully
4+
5+
on:
6+
pull_request:
7+
- main
8+
- 'release-[0-9]+.[0-9]+.[0-9]+.[0-9]+'
9+
- 'release-[0-9]+.[0-9]+.[0-9]+'
10+
- 'release-[0-9]+.[0-9]+'
11+
push:
12+
- main
13+
- 'release-[0-9]+.[0-9]+.[0-9]+.[0-9]+'
14+
- 'release-[0-9]+.[0-9]+.[0-9]+'
15+
- 'release-[0-9]+.[0-9]+'
16+
17+
concurrency:
18+
group: ${{ github.workflow }}-${{ github.ref }}
19+
cancel-in-progress: true
20+
21+
jobs:
22+
docs-build:
23+
name: Build Docs
24+
runs-on: ubuntu-latest
25+
defaults:
26+
run:
27+
working-directory: ./docs
28+
steps:
29+
- name: Checkout PR branch
30+
uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6.0.0
31+
with:
32+
fetch-depth: 0
33+
34+
- name: Setup Node
35+
uses: actions/setup-node@395ad3262231945c25e8478fd5baf05154b1d79f # v6.1.0
36+
37+
- name: Install dependencies
38+
run: npm install
39+
40+
- name: Run gen-api-docs
41+
run: npm run gen-api-docs all
42+
43+
- name: Build documentation
44+
run: npm run build

0 commit comments

Comments
 (0)