Skip to content

Lychee skips the changelog compare and tag links - #20

Merged
rennf93 merged 1 commit into
masterfrom
lychee-release-links
Oct 21, 2026
Merged

rennf93 merged 1 commit into
masterfrom
lychee-release-links

Conversation

@rennf93

@rennf93 rennf93 commented Oct 21, 2026

Copy link
Copy Markdown
Owner

Lychee no longer fails every release PR. It skips the CHANGELOG footer's compare and release tag links.

Why

#18 made lychee check the root *.md pages, CHANGELOG.md included. In a release PR the footer's [Unreleased] compare link and the new version's tag link point at a tag that is only pushed after the PR merges. On #19, docs CI failed with exactly those two: [404] .../compare/v0.2.5...HEAD and [404] .../releases/tag/v0.2.5.

What changed

lychee.toml excludes ^https://github\.com/rennf93/murmur/compare/ and ^https://github\.com/rennf93/murmur/releases/tag/, with a comment saying why.

Issue

No issue. Found on #19.

How it was verified

  • git grep finds those URL prefixes only in CHANGELOG.md:140-147, so nothing else is skipped. The [0.1.0] commit link, the repo root, /issues, /pull, /releases, /blob and /security links stay checked (lychee --dump).
  • A copy of CHANGELOG.md with the footer set to an unreleased v9.9.9: master's config exits 2 with [404] .../compare/v9.9.9...HEAD; the new config reports 0 Errors, 8 Excluded.
  • The full CI inputs with the new config: 90 OK, 0 Errors, 9 Excluded.
  • npm run coverage: Tests 508 passed (508), 100 percent. typos exit 0, markdownlint 0 issues.
  • An independent review confirmed the above. It noted that the simulated tag link was an unused reference, so lychee never extracted it; the tag exclusion is shown by Release 0.2.5 #19's real releases/tag/v0.2.5 404 instead.

Behavior changes

A typo in a footer version link is no longer caught, for the already published tags too.

@CLAassistant

CLAassistant commented Oct 21, 2026 •

Copy link
Copy Markdown

CLA assistant check
All committers have signed the CLA.

@rennf93
rennf93 merged commit 908459f into master Oct 21, 2026
20 of 21 checks passed
@rennf93
rennf93 deleted the lychee-release-links branch October 21, 2026 01:34
@rennf93 rennf93 mentioned this pull request Oct 21, 2026
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.

2 participants