Merge 401851faf540c408c29b315c945a555437d15a2b into 85e6279cec87321a52edac9c87bce653a07cf6c2

Adjust positioning of user email note and permissions heading (#2044 )
Documentation update - add recommended permissions to Readme (#2043 )
2025-06-05 07:32:37 +08:00 · 2025-01-17 13:19:45 -05:00 · 2025-01-16 15:56:18 -05:00 · 2025-01-16 14:14:48 -05:00 · 2023-06-07 11:30:30 -04:00
3 changed files with 19 additions and 2 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/dist/index.js
+++ b/dist/index.js
@ -711,7 +711,11 @@ class GitCommandManager {
    }
    init() {
        return __awaiter(this, void 0, void 0, function* () {
-            yield this.execGit(['init', this.workingDirectory]);
+            yield this.execGit([
+                'init',
+                '--initial-branch=silence_warning_about_default_branch',
+                this.workingDirectory
+            ]);
        });
    }
    isDetached() {
--- a/src/git-command-manager.ts
+++ b/src/git-command-manager.ts
@ -328,7 +328,11 @@ class GitCommandManager {
  }

  async init(): Promise<void> {
-    await this.execGit(['init', this.workingDirectory])
+    await this.execGit([
+      'init',
+      '--initial-branch=silence_warning_about_default_branch',
+      this.workingDirectory
+    ])
  }

  async isDetached(): Promise<boolean> {
Author	SHA1	Message	Date
Josh Soref	b0f61e0c23	Merge 401851faf540c408c29b315c945a555437d15a2b into 85e6279cec87321a52edac9c87bce653a07cf6c2	2025-01-17 13:19:45 -05:00
Josh Gross	85e6279cec	Adjust positioning of user email note and permissions heading (#2044 ) Some checks failed CodeQL / Analyze (javascript) (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
Josh Soref	401851faf5	Set initial-branch (#427 ) Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>	2023-06-07 11:30:30 -04:00