Add linter for CHANGELOG formatting [ci skip] #45674
Conversation
There have been a number of recent commits introducing incorrectly formatted CHANGELOG entries: - 9f0b8eb was missing an author - 936a862 had trailing whitespace - 238432d had wrong number of leading whitespace - 51852d2 had wrong number of leading whitespace in the header To prevent these inconsistencies from happening in the future, I wrote a small linter for CHANGELOG files that catches all of the above errors.
|
I would like to see how this job finds these issues, such as missing authors and extra whitespaces. Would you push some "bad" changelog entries to see how it works? Of course, we will remove/revert the "bad" entries before merging. |
skipkayhil
changed the title
|
Confirmed https://github.com/rails/rails/runs/7551769464?check_suite_focus=true and it looks good to me. |
|
Let me answer these questions.
Yes. I think running this job on pull requests is fine so that we can ask contributors to address offenses in the CHANGELOG.
I think under rails/rails https://github.com/rails/rails is fine. |
|
I think we can revert 3fcf282 and drop these two commits from this pull request. We can see how this job detects offenses below. https://github.com/rails/rails/runs/7551769464?check_suite_focus=true |
skipkayhil
force-pushed
the
add-changelog-linter
branch
from
3fcf282
to
a477096
Compare
|
Let's open this pull request for a couple of more days to see if there are any other feedback. |
Summary
There have been a number of recent commits introducing incorrectly
formatted CHANGELOG entries:
To prevent these inconsistencies from happening in the future, I wrote a
small linter for CHANGELOG files that catches all of the above errors.
Other Information
rails/railswants running on Pull Requests? Currently I have it running as a daily job in my repo but it would definitely be more effective on PRsrails/rails/rails/?/a gem?Very open to feedback on the approach and would appreciate any suggestions!
cc @yahonda ref #45559 (comment)