Skip to content

Commit 2901d00

Browse files
chore(ci): add a new workflow to build docs in new PRs (#7002)
Add a new workflow to build docs on new PRs
1 parent 69b1eab commit 2901d00

File tree

2 files changed

+51
-1
lines changed

2 files changed

+51
-1
lines changed

.github/workflows/quality_check.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: Code quality
1+
name: Quality check - check code
22

33
# PROCESS
44
#
Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
name: Quality check - Build docs
2+
3+
# PROCESS
4+
#
5+
# 1. Install all dependencies required to build the docs
6+
# 2. Build the docs
7+
8+
# USAGE
9+
#
10+
# Always triggered on new PRs, PR changes and PR merge.
11+
12+
13+
on:
14+
pull_request:
15+
paths:
16+
- "docs/**"
17+
- "examples/**"
18+
- "mkdocs.yml"
19+
branches:
20+
- develop
21+
push:
22+
paths:
23+
- "docs/**"
24+
- "examples/**"
25+
- "mkdocs.yml"
26+
branches:
27+
- develop
28+
29+
permissions:
30+
contents: read
31+
32+
jobs:
33+
build_docs:
34+
runs-on: ubuntu-latest
35+
permissions:
36+
contents: read # checkout code only
37+
steps:
38+
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
39+
- name: Set up Python
40+
uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0
41+
with:
42+
python-version: 3.13
43+
- name: Install doc generation dependencies
44+
run: |
45+
cat docs/requirements.txt
46+
pip install --require-hashes -r docs/requirements.txt
47+
- name: Build docs
48+
run: |
49+
rm -rf site
50+
mkdocs build

0 commit comments

Comments
 (0)