Generate full release contributors list in release changelog #38704
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
|
Size Change: 0 B Total Size: 1.15 MB ℹ️ View Unchanged
|
|
I think you need to update the snapshots for existing tests that cover the changelog. Otherwise, it looks like a great way to make the release page nicer on GitHub 🎉 |
gziolo
approved these changes
Feb 10, 2022
My sentiments exactly. If this doesn't work out we can revert it or enhance it further if it's a success 🚀 |
priethor
reviewed
Feb 11, 2022
| ); | ||
| ) + | ||
| ' - @' + | ||
| issue.user.login; |
There was a problem hiding this comment.
Thanks for trying this, @getdave. I think listing the contributors participating in the release will improve the release page. However, I am not sure listing them next to each PR is the way we should go. I think it adds too granular info to the changelog, making it harder to read and focus on the PRs themselves. Moreover, copying the list of PRs alone elsewhere (Google Docs, make.wordpress.org/core) will need an extra step (e.g., a regex) to remove each author.
My two cents is adding the list of contributors to the bottom would be a nice middle ground. Later on, other participants could be added, apart from the person merging each PR.
There was a problem hiding this comment.
Good points. Fine be me. This is easily modified. I'll try that next week.
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.
Description
In #38372 we added a list of first time contributors to the changelog. This has the unintended side effect of causing Github to auto-generate a list of "Contributors" (see below):
This seems to be due to the inclusion of the usernames of each contributor next to their listed PR.
This PR builds upon that functionality by adding the username alongside each of the listed changelog entries. This has the consequence of generating a full "Contributors" list which includes everyone who merged a PR in this release.
It should look like the screenshot above, but the
Contributorssection should include all the usernames who are mentioned in the changelog.This is not a full "props" solution but serves as a stepping stone to something more robust.
Testing Instructions
npm run changelog -- --milestone="Gutenberg 12.5"in root of Gutenberg repo.- @someusernameappended to each PR.Screenshots
Types of changes
New feature (non-breaking change which adds functionality)
Checklist:
*.native.jsfiles for terms that need renaming or removal).