From cbbaa11bf69aeb71703321ab0dec0b7cf3278c6f Mon Sep 17 00:00:00 2001 From: Santhi Prakash Date: Sun, 23 Aug 2026 17:41:42 +0000 Subject: [PATCH] ci: ignore repo-local and localhost links in mdox link validation (fixes #2879) - Enable explicitLocalValidators in .mdox.validator.yaml so absolute local/website-root links are routed through the configured validators. - Add an ignore rule for repo-local absolute URLs (^/.*) which resolve to site routes rather than files on the local filesystem. - Add a catch-all local validator to keep validating relative local links. - Pin mdox to the commit (e88e0a8) that introduces explicitLocalValidators and the local validator type. The external URL ignore rule already covers http://localhost links, so no additional localhost rule is required. Unrelated mdox-fmt drift in docs/guides/cadvisor.md is dropped from this PR per review. Signed-off-by: Santhi Prakash --- .mdox.validator.yaml | 9 ++++++++- Makefile | 2 +- 2 files changed, 9 insertions(+), 2 deletions(-) diff --git a/.mdox.validator.yaml b/.mdox.validator.yaml index 065e76794..abc003a8a 100644 --- a/.mdox.validator.yaml +++ b/.mdox.validator.yaml @@ -1,6 +1,13 @@ version: 1 +explicitLocalValidators: true # Don't check external URLs, they can time-out a lot (rate limits). +# Don't check repo-local absolute URLs, they resolve to site routes rather than +# files on the local filesystem. Keep validating other local (relative) links. validators: - type: ignore - regex: http(s|)://.* \ No newline at end of file + regex: http(s|)://.* + - type: ignore + regex: ^/.* + - type: local + regex: ^.*$ diff --git a/Makefile b/Makefile index 083acdf23..25fc44a5b 100644 --- a/Makefile +++ b/Makefile @@ -3,7 +3,7 @@ MD_FILES_TO_FORMAT=docs/specs/om/open_metrics_spec_2_0.md MDOX="mdox" $(MDOX): - @go install github.com/bwplotka/mdox@v0.9.0 + @go install github.com/bwplotka/mdox@e88e0a8655a0c91ef6a849edd29798e7e4809d75 .PHONY: help help: ## Displays help.