Skip to content
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

Add cross-file anchor link check (use lychee for markdown link checking) #1697

Open
wants to merge 8 commits into
base: main
Choose a base branch
from
Open

Add cross-file anchor link check (use lychee for markdown link checking) #1697

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
6297346
lychee
trask Dec 5, 2024
37388c8
more retries
trask Dec 18, 2024
cb1578e
just to be safe
trask Dec 18, 2024
9a04ca9
remove redundant tag
trask Dec 18, 2024
e36a2a8
Remove old config
trask Dec 18, 2024
2d332d6
move to toml config
trask Dec 18, 2024
b663e2c
Update .github/workflows/checks.yml
trask Dec 18, 2024
91835ef
single regex
trask Dec 18, 2024
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
15 changes: 15 additions & 0 deletions .lychee.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
include-fragments = true

accept = ["200..=299", "403"]

exclude = [
"^https://www.foo.bar",
# excluding links to pull requests and issues is done for performance
"^https://github.com/open-telemetry/semantic-conventions/(pull|issue)/\\d+$"
]

# better to be safe and avoid failures
max-retries = 6

# insecure is currently needed for https://osi-model.com
insecure = true
37 changes: 0 additions & 37 deletions .markdown_link_check_config.json
View file
Open in desktop

This file was deleted.

12 changes: 7 additions & 5 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,11 +68,13 @@ misspell-correction: $(MISSPELL)

.PHONY: markdown-link-check
markdown-link-check:
@if ! npm ls markdown-link-check; then npm install; fi
@for f in $(ALL_DOCS); do \
npx --no -- markdown-link-check --quiet --config .markdown_link_check_config.json $$f \
|| exit 1; \
done
docker run --rm \
--mount 'type=bind,source=$(PWD),target=/home/repo' \
lycheeverse/lychee \
--config home/repo/.lychee.toml \
--root-dir /home/repo \
-v \
home/repo

.PHONY: markdown-link-check-changelog-preview
markdown-link-check-changelog-preview:
Expand Down
Loading