Set default user.name and user.email #584
Open
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.
This PR sets up a default
user.name
anduser.email
for scriptinggit commit
. Users can continue to configure their own values as now, this PR just affords the option not to.Shouldn't affect existing users: If users
git config --global user.{name,email}
beforeactions/checkout
, this will respect existing values. If theygit config --global
afteractions/checkout
they'll overwrite these defaults. If theygit config --local
(before or after), those values take precedence.Fixes #13, although the issue proposed defaulting to the author/user from the event that triggered the action.
Also discussed in #158, although the PR doesn't propose defaults.
Configuring
user.{name,email}
/scriptinggit commit
is documented in the README.md. The relevant text of ADR 0153 reads:Default user.name
I used
$GITHUB_WORKFLOW
for the defaultuser.name
because it's the most helpful value to have in there? Other proposals include the current README.md value ("github-actions") and the author/user from the event that triggered the action.Here's how
$GITHUB_WORKFLOW
looks in GitHub's UI -- however I'm equally happy if a different default is implemented:Default user.email
I went with the current README.md value ("github-actions@github.com"), however @JojOatXGME lays out the options.