diff --git a/README.md b/README.md index b0f6224..64dc025 100644 --- 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 diff --git a/dist/index.js b/dist/index.js index b0db713..3c21f65 100644 --- 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() { diff --git a/src/git-command-manager.ts b/src/git-command-manager.ts index 8e42a38..178d0b2 100644 --- a/src/git-command-manager.ts +++ b/src/git-command-manager.ts @@ -328,7 +328,11 @@ class GitCommandManager { } async init(): Promise { - await this.execGit(['init', this.workingDirectory]) + await this.execGit([ + 'init', + '--initial-branch=silence_warning_about_default_branch', + this.workingDirectory + ]) } async isDetached(): Promise {