From d48599a2993b80f59181066b1295533674d04d4d Mon Sep 17 00:00:00 2001 From: Jack Bates Date: Wed, 15 Sep 2021 09:59:02 -0700 Subject: [PATCH 1/4] Set default user.name and user.email --- src/git-source-provider.ts | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/src/git-source-provider.ts b/src/git-source-provider.ts index 42a12e0..1da0bfc 100644 --- a/src/git-source-provider.ts +++ b/src/git-source-provider.ts @@ -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' @@ -216,6 +217,14 @@ export async function getSource(settings: IGitSourceSettings): Promise { 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', 'github-actions@github.com', true) + } } finally { // Remove auth if (!settings.persistCredentials) { From f787e7d544c130d1f240b14444b0ce9724a4f6db Mon Sep 17 00:00:00 2001 From: Jack Bates Date: Fri, 6 Oct 2023 06:25:44 -0700 Subject: [PATCH 2/4] Apply suggestions from code review Co-authored-by: Usman --- src/git-source-provider.ts | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/git-source-provider.ts b/src/git-source-provider.ts index 1da0bfc..18aed12 100644 --- a/src/git-source-provider.ts +++ b/src/git-source-provider.ts @@ -219,10 +219,10 @@ export async function getSource(settings: IGitSourceSettings): Promise { ) // Set default author - if (!await git.configExists('user.name', true) { + if (!await git.configExists('user.name', true)) { await git.config('user.name', github.context.workflow, true) } - if (!await git.configExists('user.email', true) { + if (!await git.configExists('user.email', true)) { await git.config('user.email', 'github-actions@github.com', true) } } finally { From 009b9ae9e446ad8d9b8c809870b0fbcc5e03573e Mon Sep 17 00:00:00 2001 From: Ben Wells Date: Thu, 16 Jan 2025 14:14:48 -0500 Subject: [PATCH 3/4] Documentation update - add recommended permissions to Readme (#2043) * Update README.md * Update README.md Co-authored-by: Josh Gross --------- Co-authored-by: Josh Gross --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index b0f6224..f28fec7 100644 --- a/README.md +++ b/README.md @@ -311,6 +311,16 @@ jobs: git commit -m "generated" git push ``` + +## Recommended permissions + +When using the `checkout` action in your GitHub Actions workflow, it is recommended to set the following `GITHUB_TOKEN` permissions to ensure proper functionality, unless alternative auth is provided via the `token` or `ssh-key` inputs: + +```yaml +permissions: + contents: read +``` + *NOTE:* The user email is `{user.id}+{user.login}@users.noreply.github.com`. See users API: https://api.github.com/users/github-actions%5Bbot%5D From 85e6279cec87321a52edac9c87bce653a07cf6c2 Mon Sep 17 00:00:00 2001 From: Josh Gross Date: Thu, 16 Jan 2025 15:56:18 -0500 Subject: [PATCH 4/4] Adjust positioning of user email note and permissions heading (#2044) --- README.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index f28fec7..64dc025 100644 --- a/README.md +++ b/README.md @@ -312,7 +312,9 @@ jobs: git push ``` -## Recommended permissions +*NOTE:* The user email is `{user.id}+{user.login}@users.noreply.github.com`. See users API: https://api.github.com/users/github-actions%5Bbot%5D + +# Recommended permissions When using the `checkout` action in your GitHub Actions workflow, it is recommended to set the following `GITHUB_TOKEN` permissions to ensure proper functionality, unless alternative auth is provided via the `token` or `ssh-key` inputs: @@ -321,9 +323,6 @@ permissions: contents: read ``` -*NOTE:* The user email is `{user.id}+{user.login}@users.noreply.github.com`. See users API: https://api.github.com/users/github-actions%5Bbot%5D - - # License The scripts and documentation in this project are released under the [MIT License](LICENSE)