Fix changelog item generation #8945
Merged
Conversation
This file contains 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
Oh, right, I forgot to copy it over from You changes are great. How about moving your spec to |
marcandre
reviewed
Oct 26, 2020
marcandre
reviewed
Oct 26, 2020
| @@ -51,7 +51,7 @@ def last_commit_title | |||
| end | |||
|
|
|||
| def extract_id(body) | |||
| /^\[Fixes #(\d+)\] (.*)/.match(body)&.captures || [nil, body] | |||
| /^\[Fix(?:es)? #(\d+)\] (.*)/.match(body)&.captures || [nil, body] | |||
There was a problem hiding this comment.
Cool, didn't know we could write either 😅
- Properly handle issues referring to other rubocop-hq repos - Only evaluate links at the beginning of a changelog item - Ensure that the link reference is valid (eg. not [#x] or []) - Ensure that a changelog item does not contain [Fix(es) #...] - Fixed improper CHANGELOG.md item
dvandersluis
force-pushed
the
fix/changelog
branch
from
1bed908
to
4cd1337
Compare
|
@marcandre updated, merged my spec into yours, thanks! |
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.
Re #8930. I found a couple issues when using
rake changelog:fixto write a changelog item for another PR. Foremost,[Fix #xxxx]as requested in the contributing guidelines was not being parsed properly (it was only looking forFixes, now it accepts both).tasks/changelog.rbdid not have a spec, so I added a basic one that just covers this issue but is not exhaustive.I also updated the tests in
project_spec.rb:[Fix #xxxx]in it.[#x]as invalid in a changelog itemThe last item is potentially contentious because the rake task prefaces items with
* [#x](https://github.com/rubocop-hq/rubocop/pull/x):if a ref ID cannot be found, which will then causebundle exec rake defaultto fail. This is kind of a paradox if there isn't already an issue to refer to (ie. sometimes in practice the link is to the PR that merges the change, which doesn't exist beforerake defaultis run), so I'm not 100% sure about this, but I think the test is valuable in general to ensure we don't end up with[#x]in the changelog./cc @marcandre
Before submitting the PR make sure the following are checked:
[Fix #issue-number](if the related issue exists).master(if not - rebase it).bundle exec rake default. It executes all tests and RuboCop for itself, and generates the documentation.