FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

Rewrite RTD configuration to use build.jobs rather than build.commands by zware · Pull Request #149429 · python/cpython · GitHub

  1. python
  2. cpython

Repository navigation

Rewrite RTD configuration to use build.jobs rather than build.commands #149429

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
zware merged 7 commits into from
May 6, 2026
Conversation 18 Commits 7 Checks 47 Files changed
Merged

Rewrite RTD configuration to use build.jobs rather than build.commands #149429

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
40631ea
Rewrite RTD configuration to use build.jobs rather than build.commands
zware May 5, 2026
cd23955
fixup! Rewrite RTD configuration to use build.jobs rather than build.…
zware May 5, 2026
d8a4832
Use stricter Bash options
zware May 5, 2026
e4aa5df
sh not Bash
zware May 5, 2026
c9428cc
fixup! Rewrite RTD configuration to use build.jobs rather than build.…
zware May 6, 2026
1691254
fixup! Rewrite RTD configuration to use build.jobs rather than build.…
zware May 6, 2026
569bf42
fixup! Rewrite RTD configuration to use build.jobs rather than build.…
zware May 6, 2026
File filter

Filter by extension

Filter by extension .yml  (1) All 1 file type selected
Viewed files
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Unified
Split
Hide whitespace
Diff view
Unified
Split
Hide whitespace
64 changes: 44 additions & 20 deletions .readthedocs.yml
Show comments
View file
Open in desktop
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Original file line number Diff line number Diff line change
Expand Up @@ -12,23 +12,47 @@ build:
tools:
python: "3"

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; echo $?)" -eq 0 ];
then
echo "No changes to Doc/ - exiting the build.";
exit 183;
fi

- asdf plugin add uv
- asdf install uv latest
- asdf global uv latest
- make -C Doc venv html
- mkdir _readthedocs
- mv Doc/build/html _readthedocs/html
jobs:
post_checkout:
# https://docs.readthedocs.com/platform/stable/guides/build/skip-build.html#skip-builds-based-on-conditions
#
# Cancel building pull requests when there aren't changes in the Doc
# directory or RTD configuration, or if we can't cleanly merge the base
# branch.
- |
set -eEux;
if [ "$READTHEDOCS_VERSION_TYPE" = "external" ];
then
base_branch=main;

webknjaz May 5, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Is there an env var that could be used instead of main? I imagine this isn't going to work well in backport PRs unless we check against stable branches.

zware May 5, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

My plan is to manually set base_branch to the right branch in each backport; I'm afraid RTD doesn't provide the base branch anywhere (that's documented, anyway).

webknjaz May 6, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Alright, that works as a workaround. Though, I'd rather have RTD fix it.

curl -s https://api.github.com/repos/python/cpython/pulls/149429 | jq --raw-output '.base.ref' will get you what you want unless they rate-limit you (which is likely).

GHA provides a GITHUB_EVENT_PATH env var with a file path to the entire webhook payload. RTD should do the same so that people wouldn't have to ask them to expose every single bit that GH sends them w/o additional API requests one by one.

StanFromIreland May 31, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Oh I just saw this discussion, I wrote #150690 with it.
git fetch --depth=50 origin $base_branch:origin-$base_branch;
for attempt in $(seq 10);

webknjaz May 5, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

I think @StanFromIreland added a bash script for progressive unshallowing some time ago based on my experiments elsewhere. We could probably reuse that.

webknjaz May 5, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Oh, he embedded bash in YAML: #147975 (comment). But perhaps, if it's extracted into Tools/, we could deduplicate the logic.

zware May 5, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Deduplicating sounds good, but I think I'll leave that for a later cleanup.

webknjaz May 6, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Ack. A follow-up sounds good.
do
if ! git merge-base HEAD origin-$base_branch;
then
git fetch --deepen=50 origin $base_branch;
Comment thread
webknjaz marked this conversation as resolved.
else
break;
fi;
done;
if ! git -c "user.name=rtd" -c "user.email=no-reply@readthedocs.org" merge --no-stat --no-edit origin-$base_branch;
then
echo "Unsuccessful merge with '$base_branch' branch, skipping the build";
exit 183;
fi;
if git diff --exit-code --stat origin-$base_branch -- Doc/ .readthedocs.yml;
then
echo "No changes to Doc/ - skipping the build.";
exit 183;
fi;
fi;
create_environment:
- echo "Skipping default environment creation"
install:
- asdf plugin add uv
- asdf install uv latest
- asdf global uv latest
build:
html:
- make -C Doc venv html
- mkdir -p "$READTHEDOCS_OUTPUT"
- mv Doc/build/html "$READTHEDOCS_OUTPUT/"
Loading
Back | FazBrowse Home | New Git URL