Clarify commit_author input option
#315
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
alejandrop79
added a commit
to Lattice-Trade/git-auto-commit-action
that referenced
this pull request
Jun 11, 2025
* Add test for multi-line commit messages * Update README.md * Update README.md Closes stefanzweifel#281 * Update Author Email Address * Add permissions block to Workflows * Fix Typo in Workflow comments * Mention new permission requirements in usage docs Starting February 2nd 2023, GitHub changed the default permissions of the GITHUB_TOKEN to be read-only in all new repositories.[1] git-auto-commits needs `write`-permissions for the `contents`-key in order to work properly. This commits updates the usage section, to mention the need for the permission requirements. The examples have also been updated to reflect that change. [1]: https://github.blog/changelog/2023-02-02-github-actions-updating-the-default-github_token-permissions-to-read-only/ * Use actions/checkout@v3 in examples * Fix Comment in README * Bump bats from 1.8.2 to 1.9.0 (stefanzweifel#282) Bumps [bats](https://github.com/bats-core/bats-core) from 1.8.2 to 1.9.0. - [Release notes](https://github.com/bats-core/bats-core/releases) - [Changelog](https://github.com/bats-core/bats-core/blob/master/docs/CHANGELOG.md) - [Commits](bats-core/bats-core@v1.8.2...v1.9.0) --- updated-dependencies: - dependency-name: bats dependency-type: direct:development update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Fix docs about using in public forks Update docs section about using the Action in public forks. Add warning about current issue when the forks lives under an organisation. Mark section about running a workflow in the head repository as outdated, as I was not able to reproduce this in test projects. See stefanzweifel#211 (comment) for more details. * Update Test * Seems like there is an extra space (stefanzweifel#288) * Bump github/super-linter from 4 to 5 (stefanzweifel#289) Bumps [github/super-linter](https://github.com/github/super-linter) from 4 to 5. - [Release notes](https://github.com/github/super-linter/releases) - [Changelog](https://github.com/github/super-linter/blob/main/docs/release-process.md) - [Commits](github/super-linter@v4...v5) --- updated-dependencies: - dependency-name: github/super-linter dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Bump bats from 1.9.0 to 1.10.0 (stefanzweifel#293) Bumps [bats](https://github.com/bats-core/bats-core) from 1.9.0 to 1.10.0. - [Release notes](https://github.com/bats-core/bats-core/releases) - [Changelog](https://github.com/bats-core/bats-core/blob/master/docs/CHANGELOG.md) - [Commits](bats-core/bats-core@v1.9.0...v1.10.0) --- updated-dependencies: - dependency-name: bats dependency-type: direct:development update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Bump actions/checkout from 3 to 4 (stefanzweifel#302) Bumps [actions/checkout](https://github.com/actions/checkout) from 3 to 4. - [Release notes](https://github.com/actions/checkout/releases) - [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md) - [Commits](actions/checkout@v3...v4) --- updated-dependencies: - dependency-name: actions/checkout dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Use actions/checkout v4 in examples stefanzweifel#302 (comment) * Fix Typo * Update node version to node20 (stefanzweifel#300) Co-authored-by: ryudai.takai * Update CHANGELOG * Use v5 in update-changelog Workflow * Use v5 in README * Use new Markdown Alerts in README * Little Doc Updates * Add Alert about pull_request_target stefanzweifel#211 (comment) * Remove outdated docs * Don't switch local branches * Update Test * Update Tests * Update Tests * Update Tests * Remove no longer needed tests * Temp disable assertions * Remove no longer used input options from tests * Remove _switch_to_branch function * Update Assertion * Remove skip_fetch, skip_checkout and create_branch * Remove removed options from README * Clarify `commit_author` input option (stefanzweifel#315) * Clarify `commit_author` input option * Update README.md --------- Co-authored-by: Stefan Zweifel <[email protected]> * Bump release-drafter/release-drafter from 5 to 6 (stefanzweifel#319) * Linux is not UNIX (stefanzweifel#321) * Add step id explanation for output in README.md (stefanzweifel#324) * Bump bats from 1.10.0 to 1.11.0 (stefanzweifel#325) Bumps [bats](https://github.com/bats-core/bats-core) from 1.10.0 to 1.11.0. - [Release notes](https://github.com/bats-core/bats-core/releases) - [Changelog](https://github.com/bats-core/bats-core/blob/master/docs/CHANGELOG.md) - [Commits](bats-core/bats-core@v1.10.0...v1.11.0) --- updated-dependencies: - dependency-name: bats dependency-type: direct:development update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Fail if attempting to execute git commands in a directory that is not a git-repo. (stefanzweifel#326) * Fail (and log message) if attempting to execute git commands in a directory that is not a git-repo. * Add Test * Code Formatting --------- Co-authored-by: Constantin Comendant <[email protected]> Co-authored-by: Stefan Zweifel <[email protected]> * Update CHANGELOG * Add with ref github.head_ref to README * Update GPG Signing section in README * Add docs about .github/workflows pushes See stefanzweifel#322 * Fix link to "new feature request" * Update Bug Repo Form * Update bug.yaml * Add Section on preventing infinite loops to README * Bump github/super-linter from 5 to 6 (stefanzweifel#335) Bumps [github/super-linter](https://github.com/github/super-linter) from 5 to 6. - [Release notes](https://github.com/github/super-linter/releases) - [Changelog](https://github.com/github/super-linter/blob/main/CHANGELOG.md) - [Commits](github/super-linter@v5...v6) --- updated-dependencies: - dependency-name: github/super-linter dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Bump github/super-linter from 6 to 7 (stefanzweifel#342) Bumps [github/super-linter](https://github.com/github/super-linter) from 6 to 7. - [Release notes](https://github.com/github/super-linter/releases) - [Changelog](https://github.com/github/super-linter/blob/main/CHANGELOG.md) - [Commits](github/super-linter@v6...v7) --- updated-dependencies: - dependency-name: github/super-linter dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Update README.md (stefanzweifel#343) * docs(README): fix broken protected branch docs link (stefanzweifel#346) * Add Scope/Permissions documentation for PATs Closes stefanzweifel#347 * Bump bats from 1.11.0 to 1.11.1 (stefanzweifel#353) Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Include `github.actor_id` in default `commit_author` This mimics the default commit author used by GitHub and matches the format used for the default `commit_user_email`. * Update CHANGELOG * Replace Yarn with NPM * Add UPGRADING.md * Fix Typo * Throw error if repo is in detached state * Improve Error Message * Use ref in auto-commit workflow * Use ref checkout properly * docs: Update README.md per stefanzweifel#354 See stefanzweifel#354 * Update entrypoint.sh * Update action.yml * Update entrypoint.sh * Update git-auto-commit.bats * Update git-auto-commit.bats * Update README.md * Rename Input and add output * Add Tests * Update README * Update CHANGELOG * Emit warning if deprecated/removed options are used * Add git-auto-commit to warning text * Bump bats from 1.11.1 to 1.12.0 Bumps [bats](https://github.com/bats-core/bats-core) from 1.11.1 to 1.12.0. - [Release notes](https://github.com/bats-core/bats-core/releases) - [Changelog](https://github.com/bats-core/bats-core/blob/master/docs/CHANGELOG.md) - [Commits](bats-core/bats-core@v1.11.1...v1.12.0) --- updated-dependencies: - dependency-name: bats dependency-version: 1.12.0 dependency-type: direct:development update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <[email protected]> * Add deprecated inputs to fix unbound variable issue * Fix PAT instructions with Dependabot * Apply suggestions from code review * Update CHANGELOG * Disable Check if Repo is in Detached State Fixes stefanzweifel#378 * Update CHANGELOG --------- Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: Stefan Zweifel <[email protected]> Co-authored-by: Stefan Zweifel <[email protected]> Co-authored-by: Stefan Zweifel <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Pedro Amador Rodríguez <[email protected]> Co-authored-by: 高井 <[email protected]> Co-authored-by: Nikita Panuhin <[email protected]> Co-authored-by: Philip Couling <[email protected]> Co-authored-by: Christian Vermeulen <[email protected]> Co-authored-by: Constantin Comendant <[email protected]> Co-authored-by: Constantin Comendant <[email protected]> Co-authored-by: Marcelo Trylesinski <[email protected]> Co-authored-by: scarf <[email protected]> Co-authored-by: Parker Brown <[email protected]> Co-authored-by: Ross Smith II <[email protected]> Co-authored-by: Lior Dux <[email protected]> Co-authored-by: stefanzweifel <[email protected]> Co-authored-by: Sam Bull <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
As discussed in #123, clarified the default behavior of
commit_authorinput option and extended the example to include guidance on preserving the original commit author.Feel free to point out potential changes or improvements)