Add linter for release notes#703
Draft
nchammas wants to merge 4 commits into
Draft
Conversation
Contributor
Author
|
cc @huaxingao |
Contributor
Author
|
This might be overkill, but the release notes are a highly visible part of every release. Let me know if you think this linter provides enough value to justify itself. More generally, I would like to explore more standardized Markdown linting in a future PR, but these rules for release notes are specific enough that we need a custom solution. |
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.
Add a linter that identifies common issues with release notes so we can catch them before making a release.
Those issues include:
I limited some of the checks to releases from 2025 onwards so as not to flag long past releases that really don't need fixing. The only recent releases that need adjusting are a couple from last year which have the wrong URL format.
The linter script is pure Python with no external dependencies. It includes some quick tests.
Here are some example failures:
The first two are real and are addressed as part of this PR. This will break any links that point to the old URLs, but I think this is acceptable in order to make the URLs all consistent. The last error I induced just as a demonstration.
As proposed here.