Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add/mailmap #976

Merged
merged 5 commits into from
Oct 28, 2023
Merged

Add/mailmap #976

merged 5 commits into from
Oct 28, 2023

Conversation

oruebel
Copy link
Contributor

@oruebel oruebel commented Oct 27, 2023

Motivation

Some names and emails in the commit log are bad. This adds a .mailmap file such that we can fix the mapping of names and emails so they display correctly with gitlog

How to test the behavior?

Run git show 08360f8494ce97ffc965015499ddea052decdaef which shows !git for-eac.... as the author name

commit 08360f8494ce97ffc965015499ddea052decdaef
Author: !git for-each-ref --format='%(refname:short)' `git symbolic-ref HEAD` <ben.dichter.......

With the updated .mailmap the name is displayed correctly as:

commit 08360f8494ce97ffc965015499ddea052decdaef
Author: Ben Dichter <ben.dichter....

Checklist

  • Did you update CHANGELOG.md with your changes?
  • Have you checked our Contributing document?
  • Have you ensured the PR clearly describes the problem and the solution?
  • Is your contribution compliant with our coding style? This can be checked running ruff from the source directory.
  • Have you checked to ensure that there aren't other open Pull Requests for the same change?
  • Have you included the relevant issue number using "Fix #XXX" notation where XXX is the issue number? By including "Fix #XXX" you allow GitHub to close issue #XXX when the PR is merged.

@codecov
Copy link

codecov bot commented Oct 27, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (8b519aa) 88.65% compared to head (cd5be55) 88.65%.

Additional details and impacted files
@@           Coverage Diff           @@
##              dev     #976   +/-   ##
=======================================
  Coverage   88.65%   88.65%           
=======================================
  Files          45       45           
  Lines        9451     9451           
  Branches     2688     2688           
=======================================
  Hits         8379     8379           
  Misses        757      757           
  Partials      315      315           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@oruebel oruebel marked this pull request as ready for review October 27, 2023 23:52
@bendichter
Copy link
Contributor

I'm fine with this. My email is everywhere already

@oruebel
Copy link
Contributor Author

oruebel commented Oct 28, 2023

I'm fine with this. My email is everywhere already

Yeah, all the emails are in the logs already. It would be nice with git would track emails in a more private way, but unfortunately it does not. mailmap uses the email as the primary key for matching, i.e., the current entry for Ben just updates the name and the current entry for Cody updates both the name and email.

@oruebel oruebel merged commit eb9a9c5 into dev Oct 28, 2023
26 checks passed
@oruebel oruebel deleted the add/mailmap branch October 28, 2023 03:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants