Release notes with the version in the filename are history too - #22
Merged
Conversation
`release[-_ ]?notes` has been on `_HISTORICAL_NAMES` since the fastapi measurement, where one release-notes.md produced 162 findings. The pattern demanded an extension or a slash straight after the name, so it matched `release-notes.md` and walked past `docs/release_notes_v7.9.0.md`. A version number is neither. enarjord/passivbot, sweep batch 10, is where it showed. Two of its five findings are release notes naming config files deleted in later releases. Both documents are correct: the config existed at the version the filename carries. Pillow escapes this only because its notes live in a `releasenotes/` DIRECTORY, which the path rule already reads; a project that keeps them flat gets judged for the same content. Measured over every sweep batch, 147 finding lines: this suppresses exactly those two and nothing else. Tight on purpose, so a suffix that is a word rather than a version stays judged. 197 tests.
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.
release[-_ ]?noteshas been on_HISTORICAL_NAMESsince the fastapi measurement, where a singlerelease-notes.mdproduced 162 findings, more than every other document in twenty repositories combined.It could not see its own convention when a version was stamped on the filename. The pattern required an extension or a slash immediately after the name:
docs/release-notes.mdmatches.docs/release_notes_v7.9.0.mddoes not, because_v7.9.0is neither.Where it showed
enarjord/passivbot, sweep batch 10. Two of its five findings:docs/release_notes_v7.9.0.md:21configs/examples/default_trailing_grid_long_npos10.json565376e9c, four months after v7.9.0docs/release_notes_v7.10.0.md:8configs/examples/default_trailing_grid_long_npos7.json71efc3c57Both documents are correct. The config existed at the version the filename is named for, and nobody rewrites the v7.9.0 notes to track a tree they were never describing. This is the changelog argument exactly, applied to a project that keeps one file per release instead of one long file.
Pillow escapes it already, for a reason that has nothing to do with the filename: its notes live in
docs/releasenotes/2.3.2.rst, and the DIRECTORY rule reads that. A project that keeps them flat got judged for identical content.What changed, and how far
The version has to follow immediately and has to be a number.
changelog-policy.md,release-notes-process.mdandhistory-of-the-parser.mdstay judged, and there are assertions on each.Measured across every sweep batch, 147 finding lines in total: this suppresses exactly the two above and nothing else. passivbot goes from 5 broken to 3, and the three that remain are real.
197 tests.