Skip to content

Commit 18fd975

Browse files
committed
🎨🧪 Convert doc.yml workflow to be reusable
This patch is meant to simplify the maintenance of multiple complex workflow definitions that are tied together into a single workflow later on.
1 parent c90a862 commit 18fd975

File tree

2 files changed

+20
-26
lines changed

2 files changed

+20
-26
lines changed

.github/workflows/build.yml

+18-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ permissions:
2828
contents: read
2929

3030
concurrency:
31-
group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
31+
group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}-reusable
3232
cancel-in-progress: true
3333

3434
jobs:
@@ -37,6 +37,7 @@ jobs:
3737
runs-on: ubuntu-latest
3838
timeout-minutes: 10
3939
outputs:
40+
run-docs: ${{ steps.docs-changes.outputs.run-docs || false }}
4041
run_tests: ${{ steps.check.outputs.run_tests }}
4142
run_hypothesis: ${{ steps.check.outputs.run_hypothesis }}
4243
steps:
@@ -74,6 +75,22 @@ jobs:
7475
echo "Run hypothesis tests"
7576
echo "run_hypothesis=true" >> $GITHUB_OUTPUT
7677
fi
78+
- name: Get a list of the changed documentation-related files
79+
if: github.event_name == 'pull_request'
80+
id: changed-docs-files
81+
uses: Ana06/[email protected]
82+
with:
83+
filter: |
84+
Doc/**
85+
Misc/**
86+
.github/workflows/reusable-docs.yml
87+
- name: Check for docs changes
88+
if: >-
89+
github.event_name == 'pull_request'
90+
&& steps.changed-docs-files.outputs.added_modified_renamed != ''
91+
id: docs-changes
92+
run: |
93+
echo "run-docs=true" >> "${GITHUB_OUTPUT}"
7794
7895
check_generated_files:
7996
name: 'Check if generated files are up to date'

.github/workflows/doc.yml renamed to .github/workflows/reusable-docs.yml

+2-25
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,8 @@
1-
name: Docs
1+
name: 📝
22

33
on:
4+
workflow_call:
45
workflow_dispatch:
5-
#push:
6-
# branches:
7-
# - 'main'
8-
# - '3.12'
9-
# - '3.11'
10-
# - '3.10'
11-
# - '3.9'
12-
# - '3.8'
13-
# - '3.7'
14-
# paths:
15-
# - 'Doc/**'
16-
pull_request:
17-
branches:
18-
- 'main'
19-
- '3.12'
20-
- '3.11'
21-
- '3.10'
22-
- '3.9'
23-
- '3.8'
24-
- '3.7'
25-
paths:
26-
- 'Doc/**'
27-
- 'Misc/**'
28-
- '.github/workflows/doc.yml'
296

307
permissions:
318
contents: read

0 commit comments

Comments
 (0)