Skip to content

skip RTD builds if no relevant changes occur #17544

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 6 commits into from
Feb 5, 2025
Merged

skip RTD builds if no relevant changes occur #17544

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
7cda856
skip RTD builds if no relevant changes occur
ewdurbin Feb 3, 2025
77a49d5
add docs requirements files
ewdurbin Feb 3, 2025
1aa8c52
Update bin/rtd-docs
ewdurbin Feb 5, 2025
d925815
Merge branch 'main' into skip_rtd_if_no_changes
ewdurbin Feb 5, 2025
3bbeec3
Merge branch 'main' into skip_rtd_if_no_changes
ewdurbin Feb 5, 2025
8a9ea54
Apply suggestions from code review
ewdurbin Feb 5, 2025
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
12 changes: 12 additions & 0 deletions bin/rtd-docs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,20 +5,32 @@ set -e
set -x

if [ "${READTHEDOCS_PROJECT}" = "warehouse" ]; then
if [ "$READTHEDOCS_VERSION_TYPE" = "external" ] && git diff --quiet origin/main -- docs/dev requirements/docs-dev.txt .readthedocs.yaml; then
echo "Nothing relevant changed, skipping build..."
exit 183;
fi
pip install -r requirements/docs-dev.txt
asdf reshim
make -C docs/dev/ html
mkdir _readthedocs && mv docs/dev/_build/html _readthedocs/html
fi

if [ "${READTHEDOCS_PROJECT}" = "docspypiorg" ]; then
if [ "$READTHEDOCS_VERSION_TYPE" = "external" ] && git diff --quiet origin/main -- docs/user requirements/docs-user.txt .readthedocs.yaml docs/mkdocs-user-docs.yml; then
echo "Nothing relevant changed, skipping build..."
exit 183;
fi
pip install -r requirements/docs-user.txt
asdf reshim
mkdocs build -f docs/mkdocs-user-docs.yml
mkdir _readthedocs && mv docs/user-site _readthedocs/html
fi

if [ "${READTHEDOCS_PROJECT}" = "blogpypiorg" ] || [ "${READTHEDOCS_PROJECT}" = "psf-warehouse-private" ]; then
if [ "$READTHEDOCS_VERSION_TYPE" = "external" ] && git diff --quiet origin/main -- docs/blog requirements/docs-blog.txt .readthedocs.yaml docs/mkdocs-blog.yml; then
echo "Nothing relevant changed, skipping build..."
exit 183;
fi
pip install -r requirements/docs-blog.txt
asdf reshim
mkdocs build -f docs/mkdocs-blog.yml
Expand Down