From e79aebb82f6c8242ec757b7a832b64a3717e209f Mon Sep 17 00:00:00 2001 From: Hinrich Mahler <22366557+Bibo-Joshi@users.noreply.github.com> Date: Sat, 1 Mar 2025 10:50:01 +0100 Subject: [PATCH 1/4] Stabilize Linkcheck Test --- .github/workflows/docs-linkcheck.yml | 5 +++++ docs/source/conf.py | 2 ++ 2 files changed, 7 insertions(+) diff --git a/.github/workflows/docs-linkcheck.yml b/.github/workflows/docs-linkcheck.yml index f97d0cbce49..f75e66ee013 100644 --- a/.github/workflows/docs-linkcheck.yml +++ b/.github/workflows/docs-linkcheck.yml @@ -32,3 +32,8 @@ jobs: python -W ignore -m pip install -r requirements-dev-all.txt - name: Check Links run: sphinx-build docs/source docs/build/html -W --keep-going -j auto -b linkcheck + - name: Upload linkcheck output + uses: actions/upload-artifact@6f51ac03b9356f520e9adb1b1b7802705f340c2b # v4.5.0 + with: + name: linkcheck-output + path: docs/build/html/output.txt diff --git a/docs/source/conf.py b/docs/source/conf.py index 09c258c9e92..fde3a3e668b 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -111,6 +111,8 @@ # Anchors are apparently inserted by GitHub dynamically, so let's skip checking them "https://github.com/python-telegram-bot/python-telegram-bot/tree/master/examples#", r"https://github\.com/python-telegram-bot/python-telegram-bot/wiki/[\w\-_,]+\#", + # THe LGPL license link regularly causes network errors for some reason + re.escape("https://www.gnu.org/licenses/lgpl-3.0.html"), ] linkcheck_allowed_redirects = { # Redirects to the default version are okay From 109cd9f229e71c0a132647802ded40f643f7427f Mon Sep 17 00:00:00 2001 From: Bibo-Joshi <22366557+Bibo-Joshi@users.noreply.github.com> Date: Sat, 1 Mar 2025 10:52:38 +0100 Subject: [PATCH 2/4] typo Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- docs/source/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index fde3a3e668b..ddb46be6279 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -111,7 +111,7 @@ # Anchors are apparently inserted by GitHub dynamically, so let's skip checking them "https://github.com/python-telegram-bot/python-telegram-bot/tree/master/examples#", r"https://github\.com/python-telegram-bot/python-telegram-bot/wiki/[\w\-_,]+\#", - # THe LGPL license link regularly causes network errors for some reason + # The LGPL license link regularly causes network errors for some reason re.escape("https://www.gnu.org/licenses/lgpl-3.0.html"), ] linkcheck_allowed_redirects = { From bd1891161f66337c473a777ff93f96b992a30e9e Mon Sep 17 00:00:00 2001 From: Hinrich Mahler <22366557+Bibo-Joshi@users.noreply.github.com> Date: Sat, 1 Mar 2025 11:03:13 +0100 Subject: [PATCH 3/4] Always run upload step, one more stabilization --- .github/workflows/docs-linkcheck.yml | 2 ++ docs/source/conf.py | 3 +++ 2 files changed, 5 insertions(+) diff --git a/.github/workflows/docs-linkcheck.yml b/.github/workflows/docs-linkcheck.yml index f75e66ee013..49950355f53 100644 --- a/.github/workflows/docs-linkcheck.yml +++ b/.github/workflows/docs-linkcheck.yml @@ -33,6 +33,8 @@ jobs: - name: Check Links run: sphinx-build docs/source docs/build/html -W --keep-going -j auto -b linkcheck - name: Upload linkcheck output + # Run also if the previous steps failed + if: always() uses: actions/upload-artifact@6f51ac03b9356f520e9adb1b1b7802705f340c2b # v4.5.0 with: name: linkcheck-output diff --git a/docs/source/conf.py b/docs/source/conf.py index ddb46be6279..b00ba68e204 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -113,6 +113,9 @@ r"https://github\.com/python-telegram-bot/python-telegram-bot/wiki/[\w\-_,]+\#", # The LGPL license link regularly causes network errors for some reason re.escape("https://www.gnu.org/licenses/lgpl-3.0.html"), + # The doc-fixes branch may not always exist - doesn't matter, we only link to it from the + # contributing guide + re.escape("https://docs.python-telegram-bot.org/en/doc-fixes"), ] linkcheck_allowed_redirects = { # Redirects to the default version are okay From 06bab8053de1f4bfd2e347b070b28e58ef17c17d Mon Sep 17 00:00:00 2001 From: Hinrich Mahler <22366557+Bibo-Joshi@users.noreply.github.com> Date: Sat, 1 Mar 2025 11:26:13 +0100 Subject: [PATCH 4/4] Upload also json output file --- .github/workflows/docs-linkcheck.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/docs-linkcheck.yml b/.github/workflows/docs-linkcheck.yml index 49950355f53..d4b28122840 100644 --- a/.github/workflows/docs-linkcheck.yml +++ b/.github/workflows/docs-linkcheck.yml @@ -38,4 +38,4 @@ jobs: uses: actions/upload-artifact@6f51ac03b9356f520e9adb1b1b7802705f340c2b # v4.5.0 with: name: linkcheck-output - path: docs/build/html/output.txt + path: docs/build/html/output.*