AUTHORS/mailmap update (with update_authors.pl improvements)
#17316
+95
−27
Conversation
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
I've increasingly found that commits from new contributors have the author set in the "Github noreply" obfuscated style. If they do have a better canonical choice, it's usually in the Signed-off-by: trailer in the commit message. I had avoided using these in the first version of this program because they aren't always present, aren't always correct, and some commits have multiple signoffs. It seems however that requiring either the name or the email address to match the commit author sufficiently narrows the scope to be useful for the "Github noreply" situation, which is really the main sticking point. And of course, if it gets it wrong, overriding in .mailmap or AUTHORS is always an option. Sponsored-by: https://despairlabs.com/sponsor/ Signed-off-by: Rob Norris <[email protected]>
Once we've selected a best ident for the AUTHORS file, it makes sense to set up a corresponding mailmap entry for any other ident for that committer, to ensure the git history also reflects this into the future. So, here we output potential mailmap updates for a human to consider. For the moment, this needs to be done by a human, because update_authors uses git to get the author names, and thus is reliant on the mailmap contents to generate its output, so having it update mailmap directly would introduce a circular dependency that I'm not totally sure about. It's definitely better than having to go back through the history and check each commit by hand though. Sponsored-by: https://despairlabs.com/sponsor/ Signed-off-by: Rob Norris <[email protected]>
Thanks everyone! Signed-off-by: Rob Norris <[email protected]>
robn
changed the title
AUTHORS/mailmap update (with update_authors.pl improvements)
amotin
approved these changes
May 9, 2025
tonyhutter
approved these changes
May 12, 2025
|
Thinking long term, it would nice to have the GH runners flag PRs that need to update |
tonyhutter
added
Status: Accepted
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.
Motivation and Context
New contributors, new credits! Hello and welcome!
Description
The important part is the
AUTHORSandmailmapupdates. Includes @OlCe2's requested update from #17309.update_authors.plgets some improvements, to considerSigned-of-by:trailers in name matching, and to output suggestions formailmap.How Has This Been Tested?
Run program, tweak, repeat.
Types of changes
Checklist:
Signed-off-by.