Skip to content

RtD docs previews: Cancel building PRs if no changes in Doc dir #104100

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
hugovk merged 10 commits into from
May 24, 2023
Merged

RtD docs previews: Cancel building PRs if no changes in Doc dir #104100

Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
c7a07b7
Cancel building PRs when there aren't changes in the Doc directory
hugovk May 2, 2023
e610f22
The keys build.jobs and build.commands can't be used together
hugovk May 2, 2023
b2ec93d
Move "then" to same line as "if"
hugovk May 12, 2023
addeef3
Double brackets
hugovk May 12, 2023
de18c2f
Bracket both expressions
hugovk May 12, 2023
a32d767
Adjust YAML
hugovk May 16, 2023
9d2b63c
Remove duplicate 'the'
hugovk May 16, 2023
d99f08f
Merge branch 'main' into rtd-doc-dir-only
arhadthedev May 23, 2023
689dfe6
Use | for multiline string
hugovk May 23, 2023
786eee1
Fix indent
hugovk May 23, 2023
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
Prev Previous commit
Next Next commit
The keys build.jobs and build.commands can't be used together
  • Loading branch information
@hugovk
hugovk committed May 2, 2023
commit e610f227f36d03fc0fcf54db51fc36f2e08d9a4d
28 changes: 13 additions & 15 deletions .readthedocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,22 +12,20 @@ build:
tools:
python: "3"

jobs:
post_checkout:
# https://docs.readthedocs.io/en/stable/build-customization.html#cancel-build-based-on-a-condition
#
# Cancel building pull requests when there aren't changes in the Doc directory.
#
# 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.
- |
if [ "$READTHEDOCS_VERSION_TYPE" = "external" ] && git diff --quiet origin/main -- Doc/ .readthedocs.yml;
then
echo "No changes to Doc/ - exiting the build.";
exit 183;
fi

commands:
# https://docs.readthedocs.io/en/stable/build-customization.html#cancel-build-based-on-a-condition
#
# Cancel building pull requests when there aren't changes in the Doc directory.
#
# 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.
- |
if [ "$READTHEDOCS_VERSION_TYPE" = "external" ] && git diff --quiet origin/main -- Doc/ .readthedocs.yml;
then
Comment thread
hugovk marked this conversation as resolved.
Outdated
echo "No changes to Doc/ - exiting the build.";
exit 183;
fi

- make -C Doc venv html
- mkdir _readthedocs
- mv Doc/build/html _readthedocs/html