Skip to content

feat: skip expensive build steps when source files unchanged (dorny/paths-filter) #14713

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
Copilot wants to merge 2 commits into
base: master
Choose a base branch
from
Draft

feat: skip expensive build steps when source files unchanged (dorny/paths-filter) #14713

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2743928
Initial plan
Copilot May 1, 2026
4952f25
feat: skip expensive steps when source files unchanged using dorny/pa…
Copilot May 1, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 41 additions & 4 deletions .github/workflows/sphinxbuild.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,21 +58,34 @@ jobs:
- name: Checkout repository
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2

- name: Check if manual source changed
uses: dorny/paths-filter@de90cc6fb38fc0963ad72b210f1f284cd68cea36 # v3.0.2
id: filter
with:
filters: |
changed:
- '${{ matrix.manual.directory }}/**'
- 'requirements.txt'
- '.github/workflows/sphinxbuild.yml'

- name: Set up Python
if: steps.filter.outputs.changed == 'true'
uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6.2.0
with:
python-version: "3.13"
cache: "pip"

- name: Install pip dependencies
if: steps.filter.outputs.changed == 'true'
run: python -m pip install -r requirements.txt

- name: Build html documentation
if: steps.filter.outputs.changed == 'true'
run: cd ${{ matrix.manual.directory }} && make ${{ matrix.manual.make_target }}

- name: Upload static documentation
if: ${{ matrix.manual.publish && steps.filter.outputs.changed == 'true' }}
uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
if: ${{ matrix.manual.publish }}
with:
name: ${{ matrix.manual.name }}
path: ${{ matrix.manual.directory }}/${{ matrix.manual.build_path }}
Expand Down Expand Up @@ -172,17 +185,31 @@ jobs:
- name: Checkout repository
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2

- name: Check if manual source changed
uses: dorny/paths-filter@de90cc6fb38fc0963ad72b210f1f284cd68cea36 # v3.0.2
id: filter
with:
filters: |
changed:
- '${{ matrix.manual.directory }}/**'
- 'requirements.txt'
- '.devcontainer/Dockerfile'
- '.github/workflows/sphinxbuild.yml'

- name: Set up Python
if: steps.filter.outputs.changed == 'true'
uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6.2.0
with:
python-version: "3.13"
# pip cache is not compatible with the Docker container
# cache: "pip"

- name: Install pip dependencies
if: steps.filter.outputs.changed == 'true'
run: python -m pip install -r requirements.txt

- name: Compute PDF release version
if: steps.filter.outputs.changed == 'true'
id: pdf_version
run: |
branch="${GITHUB_REF#refs/heads/}"
Expand All @@ -193,6 +220,7 @@ jobs:
fi

- name: Build pdf documentation
if: steps.filter.outputs.changed == 'true'
env:
DOCS_RELEASE: ${{ steps.pdf_version.outputs.release }}
run: |
Expand All @@ -202,6 +230,7 @@ jobs:
ls -la ${{ matrix.manual.build_pdf_path }}

- name: Upload PDF documentation
if: steps.filter.outputs.changed == 'true'
uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
with:
name: ${{ matrix.manual.name }}-pdf
Expand Down Expand Up @@ -390,6 +419,16 @@ jobs:
done
ls -la stage/*

- name: Build lychee path list
run: |
branch="${{ needs.stage-and-check.outputs.branch_name }}"
: > /tmp/lychee-paths.txt
[ -d "stage/${branch}/user_manual" ] && find "stage/${branch}/user_manual/en" -name '*.html' >> /tmp/lychee-paths.txt || true
[ -d "stage/${branch}/admin_manual" ] && find "stage/${branch}/admin_manual" -name '*.html' >> /tmp/lychee-paths.txt || true
[ -d "stage/${branch}/developer_manual" ] && find "stage/${branch}/developer_manual" -name '*.html' >> /tmp/lychee-paths.txt || true
echo "Files to check:"
cat /tmp/lychee-paths.txt | head -20

# We need to exclude certain links from the check:
# - go.php: This is a special redirect page
# - mailto: links: These are not valid URLs and will always fail
Expand All @@ -408,9 +447,7 @@ jobs:
--exclude 'go\.php' --exclude 'mailto:' --exclude-path '.*/404\.html' --exclude-path '.*/_static/.*'
--exclude "/user_manual/" --include "/user_manual/en/"
--exclude '^file://.*/stage/(latest|stable|[0-9]+)/(developer_manual|admin_manual|user_manual)/?$'
'stage/${{ needs.stage-and-check.outputs.branch_name }}/user_manual/en/**/*.html'
'stage/${{ needs.stage-and-check.outputs.branch_name }}/admin_manual/**/*.html'
'stage/${{ needs.stage-and-check.outputs.branch_name }}/developer_manual/**/*.html'
@/tmp/lychee-paths.txt

# ============================================================================
# DEPLOY
Expand Down
Loading