Skip to content

links.txt checker script#115

Draft
mbarchie wants to merge 2 commits into
mainfrom
links-txt-checker
Draft

links.txt checker script#115
mbarchie wants to merge 2 commits into
mainfrom
links-txt-checker

Conversation

@mbarchie

Copy link
Copy Markdown
Contributor

Adds automated validation for doc/links.txt and wires it into CI.

  • scripts/check_links_txt.py: static checks (URL syntax, duplicate names, unresolved |ncs_version_number|, unused link warnings) and optional online checks (HTTP errors, permanent redirects)
  • Doc build CI: runs static validation before make html
  • Compliance CI: replaces the bash/curl loop with the script; probes only added link lines in the PR (--changed-only), expands |ncs_version_number| from nrf/VERSION, fails on permanent redirects and HTTP 403

Local usage:

python3 scripts/check_links_txt.py
python3 scripts/check_links_txt.py --online --changed-only --fail-on-permanent-redirect --fail-on-403

mbarchie added 2 commits June 22, 2026 11:03
Add a static and optional online checker for doc/links.txt, including
syntax checks, unused-link detection, and HTTP probing with redirect
handling.

Jira: NCSDK-39692
Signed-off-by: Bartosz Meus <bartosz.meus@nordicsemi.no>
Add static validation to doc build and online checks in compliance for
added links only (--changed-only), with permanent-redirect and 403 errors.

Jira: NCSDK-39692
Signed-off-by: Bartosz Meus <bartosz.meus@nordicsemi.no>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant