Skip to content

Commit 88d14da

Browse files
webknjazAA-Turnerhugovk
authored
Convert doc.yml workflow to be reusable (#103914)
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com> Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
1 parent 96fff35 commit 88d14da

File tree

2 files changed

+25
-25
lines changed

2 files changed

+25
-25
lines changed

.github/workflows/build.yml

Lines changed: 24 additions & 1 deletion
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
config_hash: ${{ steps.config_hash.outputs.hash }}
@@ -79,6 +80,28 @@ jobs:
7980
id: config_hash
8081
run: |
8182
echo "hash=${{ hashFiles('configure', 'configure.ac', '.github/workflows/build.yml') }}" >> $GITHUB_OUTPUT
83+
- name: Get a list of the changed documentation-related files
84+
if: github.event_name == 'pull_request'
85+
id: changed-docs-files
86+
uses: Ana06/get-changed-files@v2.2.0
87+
with:
88+
filter: |
89+
Doc/**
90+
Misc/**
91+
.github/workflows/reusable-docs.yml
92+
- name: Check for docs changes
93+
if: >-
94+
github.event_name == 'pull_request'
95+
&& steps.changed-docs-files.outputs.added_modified_renamed != ''
96+
id: docs-changes
97+
run: |
98+
echo "run-docs=true" >> "${GITHUB_OUTPUT}"
99+
100+
check-docs:
101+
name: Docs
102+
needs: check_source
103+
if: fromJSON(needs.check_source.outputs.run-docs)
104+
uses: ./.github/workflows/reusable-docs.yml
82105

83106
check_generated_files:
84107
name: 'Check if generated files are up to date'

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

Lines changed: 1 addition & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,8 @@
11
name: Docs
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)