From 7cda856345edb199bde77960670e75712d4a8932 Mon Sep 17 00:00:00 2001 From: Ee Durbin Date: Mon, 3 Feb 2025 09:25:39 -0500 Subject: [PATCH 1/4] skip RTD builds if no relevant changes occur ref: https://docs.readthedocs.com/platform/stable/build-customization.html#cancel-build-based-on-a-condition --- bin/rtd-docs | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/bin/rtd-docs b/bin/rtd-docs index 05a4796f89f2..5f17da0bc3c3 100755 --- a/bin/rtd-docs +++ b/bin/rtd-docs @@ -5,6 +5,9 @@ set -e set -x if [ "${READTHEDOCS_PROJECT}" = "warehouse" ]; then + if [ "$READTHEDOCS_VERSION_TYPE" = "external" ] && git diff --quiet origin/main -- docs/dev .readthedocs.yaml; then + exit 183; + fi pip install -r requirements/docs-dev.txt asdf reshim make -C docs/dev/ html @@ -12,6 +15,9 @@ if [ "${READTHEDOCS_PROJECT}" = "warehouse" ]; then fi if [ "${READTHEDOCS_PROJECT}" = "docspypiorg" ]; then + if [ "$READTHEDOCS_VERSION_TYPE" = "external" ] && git diff --quiet origin/main -- docs/user .readthedocs.yaml docs/mkdocs-user-docs.yml; then + exit 183; + fi pip install -r requirements/docs-user.txt asdf reshim mkdocs build -f docs/mkdocs-user-docs.yml @@ -19,6 +25,9 @@ if [ "${READTHEDOCS_PROJECT}" = "docspypiorg" ]; then fi if [ "${READTHEDOCS_PROJECT}" = "blogpypiorg" ] || [ "${READTHEDOCS_PROJECT}" = "psf-warehouse-private" ]; then + if [ "$READTHEDOCS_VERSION_TYPE" = "external" ] && git diff --quiet origin/main -- docs/blog .readthedocs.yaml docs/mkdocs-blog.yml; then + exit 183; + fi pip install -r requirements/docs-blog.txt asdf reshim mkdocs build -f docs/mkdocs-blog.yml From 77a49d5dcf19b146f74a2bd5e33f4a7391751060 Mon Sep 17 00:00:00 2001 From: Ee Durbin Date: Mon, 3 Feb 2025 09:34:13 -0500 Subject: [PATCH 2/4] add docs requirements files --- bin/rtd-docs | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/bin/rtd-docs b/bin/rtd-docs index 5f17da0bc3c3..d2b2a8416daa 100755 --- a/bin/rtd-docs +++ b/bin/rtd-docs @@ -5,7 +5,7 @@ set -e set -x if [ "${READTHEDOCS_PROJECT}" = "warehouse" ]; then - if [ "$READTHEDOCS_VERSION_TYPE" = "external" ] && git diff --quiet origin/main -- docs/dev .readthedocs.yaml; then + if [ "$READTHEDOCS_VERSION_TYPE" = "external" ] && git diff --quiet origin/main -- docs/dev requirements/docs-dev.txt .readthedocs.yaml; then exit 183; fi pip install -r requirements/docs-dev.txt @@ -15,7 +15,7 @@ if [ "${READTHEDOCS_PROJECT}" = "warehouse" ]; then fi if [ "${READTHEDOCS_PROJECT}" = "docspypiorg" ]; then - if [ "$READTHEDOCS_VERSION_TYPE" = "external" ] && git diff --quiet origin/main -- docs/user .readthedocs.yaml docs/mkdocs-user-docs.yml; 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 exit 183; fi pip install -r requirements/docs-user.txt @@ -25,7 +25,7 @@ if [ "${READTHEDOCS_PROJECT}" = "docspypiorg" ]; then fi if [ "${READTHEDOCS_PROJECT}" = "blogpypiorg" ] || [ "${READTHEDOCS_PROJECT}" = "psf-warehouse-private" ]; then - if [ "$READTHEDOCS_VERSION_TYPE" = "external" ] && git diff --quiet origin/main -- docs/blog .readthedocs.yaml docs/mkdocs-blog.yml; then + if [ "$READTHEDOCS_VERSION_TYPE" = "external" ] && git diff --quiet origin/main -- docs/blog requirements/docs-blog.txt .readthedocs.yaml docs/mkdocs-blog.yml; then exit 183; fi pip install -r requirements/docs-blog.txt From 1aa8c528b8d74699d7b311b7ccd79f1e55690fc0 Mon Sep 17 00:00:00 2001 From: Ee Durbin Date: Wed, 5 Feb 2025 15:43:37 -0500 Subject: [PATCH 3/4] Update bin/rtd-docs Co-authored-by: Mike Fiedler --- bin/rtd-docs | 1 + 1 file changed, 1 insertion(+) diff --git a/bin/rtd-docs b/bin/rtd-docs index d2b2a8416daa..9699ef9bf6f3 100755 --- a/bin/rtd-docs +++ b/bin/rtd-docs @@ -6,6 +6,7 @@ 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 From 8a9ea54ffe94edda1acf82458ec328bb7ee873f8 Mon Sep 17 00:00:00 2001 From: Ee Durbin Date: Wed, 5 Feb 2025 15:50:34 -0500 Subject: [PATCH 4/4] Apply suggestions from code review --- bin/rtd-docs | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/bin/rtd-docs b/bin/rtd-docs index 9699ef9bf6f3..1166a1869270 100755 --- a/bin/rtd-docs +++ b/bin/rtd-docs @@ -6,7 +6,7 @@ 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... + echo "Nothing relevant changed, skipping build..." exit 183; fi pip install -r requirements/docs-dev.txt @@ -17,6 +17,7 @@ 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 @@ -27,6 +28,7 @@ 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