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

Support setting GIT_COMMITTER_NAME and GIT_COMMITTER_EMAIL #18749

Merged
merged 1 commit into from
Nov 11, 2024

Conversation

carlocab
Copy link
Member

  • Have you followed the guidelines in our Contributing document?
  • Have you checked to ensure there aren't other open Pull Requests for the same change?
  • Have you added an explanation of what your changes do and why you'd like us to include them?
  • Have you written new tests for your changes? Here's an example.
  • Have you successfully run brew style with your changes locally?
  • Have you successfully run brew typecheck with your changes locally?
  • Have you successfully run brew tests with your changes locally?

Our autobump workflow sets the author and committer to the user who
triggered the workflow, defaulting to @BrewTestBot for scheduled runs.

This can be confusing for maintainers when GitHub shows up as
"Unverified" because the commit is signed with @BrewTestBot's key.1

Let's fix that by configuring our autobump workflow to always commit as
@BrewTestBot, so that the committer matches the GPG signature. To do
that, we need to add support for setting GIT_COMMITTER_NAME and
GIT_COMMITTER_EMAIL.

Footnotes

  1. See, for example, fzf 0.56.1 homebrew-core#197234.

Copy link
Member

@MikeMcQuaid MikeMcQuaid left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Makes sense thanks @carlocab!

Our autobump workflow sets the author and committer to the user who
triggered the workflow, defaulting to @BrewTestBot for scheduled runs.

This can be confusing for maintainers when GitHub shows up as
"Unverified" because the commit is signed with @BrewTestBot's key.[^1]

Let's fix that by configuring our autobump workflow to always commit as
@BrewTestBot, so that the committer matches the GPG signature. To do
that, we need to add support for setting `GIT_COMMITTER_NAME` and
`GIT_COMMITTER_EMAIL`.

[^1]: See, for example, Homebrew/homebrew-core#197234.
carlocab added a commit to Homebrew/homebrew-core that referenced this pull request Nov 11, 2024
We can do this by setting `HOMEBREW_GIT_COMMITTER_NAME` and
`HOMEBREW_GIT_COMMITTER_EMAIL`.

Needs Homebrew/brew#18749, but this doesn't do anything until then, so
it doesn't hurt to merge this early.

This makes sure that autobump commits don't show up as "Unverified" in
the GitHub UI.
@MikeMcQuaid MikeMcQuaid merged commit 1c98fcc into master Nov 11, 2024
28 checks passed
@MikeMcQuaid MikeMcQuaid deleted the git-committer-info branch November 11, 2024 11:01
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.

2 participants