Merge 1bf7689f6b into 85e6279cec

Adjust positioning of user email note and permissions heading (#2044 )
Documentation update - add recommended permissions to Readme (#2043 )
2025-04-20 17:00:15 +03:00 · 2025-01-17 15:34:49 -05:00 · 2025-01-16 15:56:18 -05:00 · 2025-01-16 14:14:48 -05:00 · 2023-05-15 13:31:08 -07:00 · 2023-05-15 12:26:26 -07:00
4 changed files with 27 additions and 10 deletions
--- a/README.md
+++ b/README.md
@ -311,8 +311,17 @@ jobs:
          git commit -m "generated"
          git push
 ```
+
 *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:
+
+```yaml
+permissions:
+  contents: read
+```

 # License

--- a/test/git-auth-helper.test.ts
+++ b/test/git-auth-helper.test.ts
@ -482,6 +482,7 @@ describe('git-auth-helper tests', () => {
      )
      settings.persistCredentials = false
      settings.sshKey = ''
+      settings.submodules = true
      const authHelper = gitAuthHelper.createAuthHelper(git, settings)
      await authHelper.configureAuth()
      const mockSubmoduleForeach = git.submoduleForeach as jest.Mock<any, any>
@ -515,6 +516,7 @@ describe('git-auth-helper tests', () => {
        configureSubmoduleAuth_configuresSubmodulesWhenPersistCredentialsFalseAndSshKeySet
      )
      settings.persistCredentials = false
+      settings.submodules = true
      const authHelper = gitAuthHelper.createAuthHelper(git, settings)
      await authHelper.configureAuth()
      const mockSubmoduleForeach = git.submoduleForeach as jest.Mock<any, any>
@ -541,6 +543,7 @@ describe('git-auth-helper tests', () => {
        configureSubmoduleAuth_configuresSubmodulesWhenPersistCredentialsTrueAndSshKeyNotSet
      )
      settings.sshKey = ''
+      settings.submodules = true
      const authHelper = gitAuthHelper.createAuthHelper(git, settings)
      await authHelper.configureAuth()
      const mockSubmoduleForeach = git.submoduleForeach as jest.Mock<any, any>
@ -580,6 +583,7 @@ describe('git-auth-helper tests', () => {
      await setup(
        configureSubmoduleAuth_configuresSubmodulesWhenPersistCredentialsTrueAndSshKeySet
      )
+      settings.submodules = true
      const authHelper = gitAuthHelper.createAuthHelper(git, settings)
      await authHelper.configureAuth()
      const mockSubmoduleForeach = git.submoduleForeach as jest.Mock<any, any>
--- a/dist/index.js
+++ b/dist/index.js
@ -424,10 +424,12 @@ class GitAuthHelper {
                    core.warning(`Failed to remove '${configKey}' from the git config`);
                }
            }
+            if (this.settings.submodules) {
                const pattern = regexpHelper.escape(configKey);
                yield this.git.submoduleForeach(
                // wrap the pipeline in quotes to make sure it's handled properly by submoduleForeach, rather than just the first part of the pipeline
                `sh -c "git config --local --name-only --get-regexp '${pattern}' && git config --local --unset-all '${configKey}' || :"`, true);
+            }
        });
    }
 }
--- a/src/git-auth-helper.ts
+++ b/src/git-auth-helper.ts
@ -364,6 +364,7 @@ class GitAuthHelper {
      }
    }

+    if (this.settings.submodules) {
      const pattern = regexpHelper.escape(configKey)
      await this.git.submoduleForeach(
        // wrap the pipeline in quotes to make sure it's handled properly by submoduleForeach, rather than just the first part of the pipeline
@ -371,4 +372,5 @@ class GitAuthHelper {
        true
      )
    }
+  }
 }
Author	SHA1	Message	Date
Kaido Kert	435bc38426	Merge `1bf7689f6b` into `85e6279cec`	2025-01-17 15:34:49 -05:00
Josh Gross	85e6279cec	Adjust positioning of user email note and permissions heading (#2044 ) Some checks failed CodeQL / Analyze (push) Has been cancelled Details Licensed / Check licenses (push) Has been cancelled Details Build and Test / build (push) Has been cancelled Details Build and Test / test (macos-latest) (push) Has been cancelled Details Build and Test / test (ubuntu-latest) (push) Has been cancelled Details Build and Test / test (windows-latest) (push) Has been cancelled Details Build and Test / test-proxy (push) Has been cancelled Details Build and Test / test-bypass-proxy (push) Has been cancelled Details Build and Test / test-git-container (push) Has been cancelled Details Build and Test / test-output (push) Has been cancelled Details	2025-01-16 15:56:18 -05:00
Ben Wells	009b9ae9e4	Documentation update - add recommended permissions to Readme (#2043 ) * Update README.md * Update README.md Co-authored-by: Josh Gross <joshmgross@github.com> --------- Co-authored-by: Josh Gross <joshmgross@github.com>	2025-01-16 14:14:48 -05:00
Kaido Kert	1bf7689f6b	Update dist/index.js with changes	2023-05-15 13:31:08 -07:00
Cosimo Streppone	b9935aab1f	Tried to fix the "unstaged changes" test failure Error: Unstaged changes detected. Locally try running: git clean -ffdx && npm ci && npm run format && npm run build Error: Process completed with exit code 1. Rebased PR from #424	2023-05-15 12:26:26 -07:00
Cosimo Streppone	fbc745150c	Revert "GH#354 Updated dist/index.js build" This reverts commit `c764e5eab9`.	2023-05-15 12:25:28 -07:00
Cosimo Streppone	27cd406012	GH#354 Updated dist/index.js build	2023-05-15 12:25:25 -07:00
Cosimo Streppone	55709ffa1b	GH#354 Disabled auth submodules config when related setting is false This should help with https://github.com/actions/checkout/issues/354. The problem is that I have no idea whether such auth submodules configuration is required even when settings.submodules is false.	2023-05-15 12:23:41 -07:00