Skip to content

ci: ignore repo-local and localhost links in mdox link validation (fixes #2879) #3079

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

Merged
jan--f merged 1 commit into from
Sep 3, 2026
+9 −2
Merged

ci: ignore repo-local and localhost links in mdox link validation (fixes #2879) #3079

Show file tree
Hide file tree
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
9 changes: 8 additions & 1 deletion .mdox.validator.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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|)://.*
regex: http(s|)://.*
- type: ignore
regex: ^/.*
- type: local
regex: ^.*$
2 changes: 1 addition & 1 deletion Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Loading