Repository navigation
fix(ci): keep links out of the changelog's entries - #833
Merged
Merged
Conversation
The release copies each commit's header and a breaking change's footer into CHANGELOG.md as Markdown, and CI's docs job checks every local link of every Markdown file on each pull request and merge queue run. The commit checks refused HTML comments and spell checker directives there, but not links. A link in a header whose target did not resolve passed every check, since CHANGELOG.md is written only at release time, and after the release the docs job failed on CHANGELOG.md for every later change until the file was edited by hand. commitlint and check:merges now refuse, in a header or a breaking change's footer, a Markdown link or image in its inline and reference-style forms, a reference's definition wherever it stands, a file: address and an HTML tag with any attribute, as the link check reads more attributes than href and src. The header is found as the commit parser that commitlint and the release share finds it, past leading blank lines and gpg: lines, so the check reads the header the release writes. A tag's name is read as HTML reads it, up to a space, a slash or a closing angle bracket, and the tag check reads each character once. The body may still link, as the release leaves it out. The docs job leaves CHANGELOG.md out of its offline link check, so an entry already released cannot block merges; the weekly link run still checks it. Tests cover each form, a header after blank and gpg: lines, tag names that HTML reads but Markdown does not, a long message of tags that never close, and ordinary brackets, parentheses and angle brackets, and CONTRIBUTING.md, releasing.md and testing.md say so. Refs: GHSA-85mm-6qq5-qxrc
ixuz
enabled auto-merge
November 15, 2026 23:48
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What and why
The release copies each commit's header and a breaking change's footer into CHANGELOG.md as Markdown, and CI's docs job checks every local link of every Markdown file on each pull request and merge queue run. The commit checks refused HTML comments and spell checker directives there, but not links. A link in a header whose target did not resolve passed every check, since CHANGELOG.md is written only at release time, and after the release the docs job failed on CHANGELOG.md for every later change until the file was edited by hand.
commitlint and
check:mergesnow refuse, in a header or a breaking change's footer, a Markdown link or image in its inline and reference-style forms, a reference's definition, afile:address and an HTML tag with any attribute. The header is found the way the commit parser that commitlint and the release share finds it, so the check reads the header the release writes. The body may still link, as the release leaves it out. The docs job now leaves CHANGELOG.md out of its offline link check, so an entry already released cannot block merges; the weekly link run still checks it. CONTRIBUTING.md,docs/releasing.mdanddocs/testing.mdsay so.Refs: GHSA-85mm-6qq5-qxrc