Skip to content

docs: make SKIP_URL_CHECK=1 actually bypass the gh-file-ref URL checks #2367

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

Open
eastagiletracker wants to merge 1 commit into
base: main
Choose a base branch
from
+18 −17
Open

docs: make SKIP_URL_CHECK=1 actually bypass the gh-file-ref URL checks #2367

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
35 changes: 18 additions & 17 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -378,24 +378,25 @@ def gh_file_ref_role(name, rawtext, text, lineno, inliner, options={}, content=[

url = f"{repo_url}/blob/{version}/{text}"

print(f"Testing GitHub URL {url} exists...")
try:
status_code = requests.get(url).status_code
if status_code != 200:
message = f"[Line {lineno}] :{name}:`{text}` produces URL {url} returning status code {status_code}. " \
"Ensure your path is correct and all commits that may have moved or renamed files have been pushed to github.com."
print(message)
sys.exit(1) # Exit with error in all environments to catch dead links
except requests.exceptions.ConnectionError as e:
print(f"Warning: Network error when verifying URL {url}: {e}")
print("If you're working offline, you can set the SKIP_URL_CHECK=1 environment variable to bypass URL checks.")
if os.environ.get("SKIP_URL_CHECK") != "1":
# SKIP_URL_CHECK=1 bypasses the external URL verification entirely so local
# and offline docs builds (e.g. the Starlight sync) don't depend on network
# access to github.com. CI leaves it unset to keep validating for dead links.
if os.environ.get("SKIP_URL_CHECK") != "1":
print(f"Testing GitHub URL {url} exists...")
try:
status_code = requests.get(url).status_code
if status_code != 200:
message = f"[Line {lineno}] :{name}:`{text}` produces URL {url} returning status code {status_code}. " \
"Ensure your path is correct and all commits that may have moved or renamed files have been pushed to github.com."
print(message)
sys.exit(1) # Exit with error in all environments to catch dead links
except requests.exceptions.ConnectionError as e:
print(f"Warning: Network error when verifying URL {url}: {e}")
print("If you're working offline, you can set the SKIP_URL_CHECK=1 environment variable to bypass URL checks.")
sys.exit(1)
except Exception as e:
print(f"Warning: Failed to verify URL {url}: {e}")
sys.exit(1)
else:
print("Continuing build with SKIP_URL_CHECK=1")
except Exception as e:
print(f"Warning: Failed to verify URL {url}: {e}")
sys.exit(1)

docutils.parsers.rst.roles.set_classes(options)
node = docutils.nodes.reference(rawtext, text, refuri=url, **options)
Expand Down