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.

Sign up for GitHub

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

Set default user.name and user.email #584

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
+9 −0
Open

Set default user.name and user.email #584

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d48599a
Set default user.name and user.email
jablko Sep 15, 2021
f787e7d
Apply suggestions from code review
jablko Oct 6, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions src/git-source-provider.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import * as core from '@actions/core'
import * as github from '@actions/github'
import * as fsHelper from './fs-helper'
import * as gitAuthHelper from './git-auth-helper'
import * as gitCommandManager from './git-command-manager'
Expand Down Expand Up @@ -216,6 +217,14 @@ export async function getSource(settings: IGitSourceSettings): Promise<void> {
settings.ref,
settings.commit
)

// Set default author
if (!await git.configExists('user.name', true)) {
await git.config('user.name', github.context.workflow, true)
}
if (!await git.configExists('user.email', true)) {
await git.config('user.email', '[email protected]', true)
Comment on lines +223 to +226
Copy link

Choose a reason for hiding this comment

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

There's already a bot account for GitHub Actions. It seems like it's a decent default.

checkout/README.md

Lines 283 to 284 in 692973e

git config user.name "github-actions[bot]"
git config user.email "41898282+github-actions[bot]@users.noreply.github.com"

Suggested change
await git.config('user.name', github.context.workflow, true)
}
if (!await git.configExists('user.email', true)) {
await git.config('user.email', 'github-actions@github.com', true)
await git.config('user.name', 'github-actions[bot]', true)
}
if (!await git.configExists('user.email', true)) {
await git.config('user.email', '41898282+github-actions[bot]@users.noreply.github.com', true)

}
} finally {
// Remove auth
if (!settings.persistCredentials) {
Expand Down