build(markdown): exempt the generated CHANGELOG from MD012 (RIG-3669) - #1116
Merged
Merged
Conversation
|
😎 Stack merged successfully - details. |
rigel-mintaka
changed the title
rigel-mintaka
changed the base branch from
main
to
compass3663/rig-3663-rumdl-markdown-gate
September 11, 2026 20:31
|
Compass engineering docs preview: https://compass-repo-rig-3669-change.compass-eng-docs.pages.dev Deployed from |
mattwilkinsonn
added this pull request to stack #1127
September 12, 2026 01:19
mattwilkinsonn
approved these changes
Sep 12, 2026
Base automatically changed from
compass3663/rig-3663-rumdl-markdown-gate
to
main
September 12, 2026 02:02
release-please regenerates CHANGELOG.md on every release, and its template emits a double blank line under each version heading. That trips MD012 and fails the markdown gate, first firing on compass's very first release (PR 1032, 0.2.0). The exemption belongs in config rather than the file: a hand-fix or a `rumdl fmt` pass is overwritten at the next version bump. Scoped to the one violated rule via per-file-ignores, leaving every other rule live on the CHANGELOG, matching how the MD057 carve-outs above are scoped. Ledger-impact: none — build config only. Refs RIG-3669
rigel-mintaka
force-pushed
the
compass-repo/rig-3669-changelog-md012
branch
from
September 12, 2026 13:43
f6ee468 to
65b28c1
Compare
mattwilkinsonn
approved these changes
Sep 12, 2026
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
2 participants
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.
release-please's
CHANGELOG.mdtemplate emits a double blank line under each version heading, which trips MD012 and fails theroot:markdownlintgate. It first fires on compass's very first release PR (#1032,chore(main): release 0.2.0), where the file is created — there was no CHANGELOG before, so the gate has never seen it.The fix has to live in config rather than in the file: release-please regenerates
CHANGELOG.mdon every version bump, so a hand-fix (or arumdl fmtpass) is overwritten at the next release and CI goes red again on each one.What changed
.rumdl.toml[per-file-ignores]gains"CHANGELOG.md" = ["MD012"].Scoped to MD012 alone, not a
[global] exclude, so every other rule stays live on the file — a genuinely broken fence or heading in the changelog is still caught. This matches the block's existing posture of per-file scoping in preference to disabling a rule outright.The file is generated output rather than authored prose, which is the same basis as the agent-context payloads already carved out in
[global] exclude.Verification
Red/green against the real generated file from #1032's branch:
rc=1,MD012atCHANGELOG.md:5,:193,:268— the exact three findings CI reported.rc=0,Success: No issues found.rumdl check .:Success: No issues found in 212 files.Stacked on #1094 (RIG-3663), which introduces
.rumdl.toml; this change has no meaning before that lands.Ledger-impact: none — a lint-config carve-out, no design decision.
Refs RIG-3669
Co-authored-by: Matt Wilkinson matt@rigel.build