From c3204ed72755042f4727754903e9e6d53b424bb1 Mon Sep 17 00:00:00 2001 From: Hugo van Kemenade Date: Wed, 24 May 2023 16:54:15 +0300 Subject: [PATCH] RtD docs previews: Cancel building PRs if no changes in Doc dir (#104100) Co-authored-by: Nikita Sobolev Co-authored-by: Manuel Kaufmann Co-authored-by: Oleg Iarygin --- .readthedocs.yml | 14 ++++++++++++++ Doc/tools/templates/layout.html | 2 +- 2 files changed, 15 insertions(+), 1 deletion(-) diff --git a/.readthedocs.yml b/.readthedocs.yml index 898a9ae89db..59830c79a40 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -13,6 +13,20 @@ build: 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 + - make -C Doc venv html - mkdir _readthedocs - mv Doc/build/html _readthedocs/html + diff --git a/Doc/tools/templates/layout.html b/Doc/tools/templates/layout.html index b91f8138553..9632ad50a51 100644 --- a/Doc/tools/templates/layout.html +++ b/Doc/tools/templates/layout.html @@ -12,7 +12,7 @@ {%- if is_deployment_preview %}
{% trans %}This is a deploy preview created from a pull request. - For authoritative documentation, see the {% endtrans %} + For authoritative documentation, see {% endtrans %} {% trans %} the current stable release{% endtrans %}.
{%- endif %}