Skip to content

chore: cancel build on Read the Docs conditionally #406

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

Merged
merged 5 commits into from
Mar 15, 2024
Merged

chore: cancel build on Read the Docs conditionally #406

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
7e9e6c1
chore: cancel build on ReadTheDocs conditionally
huxuan Mar 14, 2024
179e36b
update template
huxuan Mar 14, 2024
1510708
remove skip ci check since we use pr title as commit message
huxuan Mar 15, 2024
be7e785
only check README.md for test, supposed to be revert later.
huxuan Mar 15, 2024
cea2d94
Revert "only check README.md for test, supposed to be revert later."
huxuan Mar 15, 2024
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
1 change: 1 addition & 0 deletions .github/workflows/readthedocs-preview.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,5 +18,6 @@ on:
- .readthedocs.yaml
- README.md
- docs/**
- pdm.lock
permissions:
pull-requests: write
9 changes: 9 additions & 0 deletions .readthedocs.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,15 @@ build:
post_checkout:
- env | sort
- git fetch --unshallow || true
# Cancel building pull requests when there aren't changed in the related files and folders.
# If there are no changes (git diff exits with 0) we force the command to return with 183.
# This is a special exit code on Read the Docs that will cancel the build immediately.
# Ref: https://docs.readthedocs.io/en/stable/build-customization.html#cancel-build-based-on-a-condition
- |
if [ "$READTHEDOCS_VERSION_TYPE" = "external" ] && git diff --quiet origin/main -- .github/workflows/readthedocs-preview.yml .readthedocs.yaml README.md docs/ pdm.lock;
then
exit 183;
fi
post_install:
- python -m pip install --upgrade --no-cache-dir pdm
- PDM_NO_EDITABLE=true make dev-doc
Expand Down
9 changes: 9 additions & 0 deletions template/.readthedocs.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,15 @@ build:
post_checkout:
- env | sort
- git fetch --unshallow || true
# Cancel building pull requests when there aren't changed in the related files and folders.
# If there are no changes (git diff exits with 0) we force the command to return with 183.
# This is a special exit code on Read the Docs that will cancel the build immediately.
# Ref: https://docs.readthedocs.io/en/stable/build-customization.html#cancel-build-based-on-a-condition
- |
if [ "$READTHEDOCS_VERSION_TYPE" = "external" ] && git diff --quiet origin/main -- .github/workflows/readthedocs-preview.yml .readthedocs.yaml README.md docs/ pdm.lock;
then
exit 183;
fi
post_install:
- python -m pip install --upgrade --no-cache-dir pdm
- PDM_NO_EDITABLE=true make dev-doc
Expand Down
1 change: 1 addition & 0 deletions ...po_host_type == 'github.com' %].github[% endif %]/workflows/readthedocs-preview.yml.jinja
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,5 +18,6 @@ on:
- .readthedocs.yaml
- README.md
- docs/**
- pdm.lock
permissions:
pull-requests: write