git-auto-commit-action

Removed

• Remove checkout_options as it broke everything #120

Added

• Add checkout_options #115

Changed

• Make "commit_message" optional and set default commit message to "Apply automatic changes" #103, #110

Fixes

• Better support for branch names with special characters in them #108

Removed

• Remove orphan branch feature added in #95 which broke stuff (#98)

Added

• Create orphan branch if branch does not exist #95

Changed

• Include given file_pattern in git dirty check #91

Added

• Add option to skipt the dirty check and always try to create and push a commit #82, #84

Note: Since v4.3.0 we provide major version tags. You can now use stefanzweifel/git-auto-commit-action@v4 to always use the latest release of a major version. See #77 for details.

Added

• Add new push_options-input. This feature makes it easier for you to force-push commits to a repository. #78, #72

Diff

Changed

branch-value for pull_request-event is now optional

We've updated the default branch value to be ${{ github.head_ref }} instead of ``. Due to this change, you no longer have to set a branch-value when listening to the `pull_request` event.

This change now allows you to create a single workflow which listens both to the pull_request and push-event.

name: php-cs-fixer

on:
  pull_request:
  push:
    branches:
      - master

jobs:
  php-cs-fixer:
    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@v2
      with:
        ref: ${{ github.head_ref }}

    - name: Run php-cs-fixer
      uses: docker://oskarstark/php-cs-fixer-ga

    - uses: stefanzweifel/[email protected]
      with:
        commit_message: Apply php-cs-fixer changes

Thanks to @spawnia for pointing this out and for cleaning up the README.

• #73
• #75

Fixes

• Fix issue where tags could not be created correctly #68

Added

• Update file_pattern to support multiple file paths #65

Changes

• Revert changes made in v4.1.4 #63

Fixes

• Fix issue with commit_options #64

Fixed

• Fix bug introduced in previous version, where git user configuration has been placed inline #62

Changed

• Place Git user configuration inline #59

Fixes

• Fix Issue with changes_detected-output #57

Fixes

• Fix issue where commit has not been pushed to remote repository, when no branch-option has been given #54

Added

• Add changes_detected output #49, #46
• Add tagging_message input option to create and push tags #50, #47

This release switches this Action from a Docker action to a node Action. The script now runs in the node12-environment.

This change brings the following benefits:

• Faster run time, as Docker image does not have to be built for every Workflow run
• Tools like husky can now be executed before a commit is created.

See #45 for more information.

v3.0.0 comes with a couple of breaking changes and 3 new input options.

Breaking changes

1. This Action now requires that you use at least action/checkout@v2. The action/checkout team made some significant changes to the Action which we take advantage of (see next point).
2. This Action now longer requires a GITHUB_TOKEN. As mentioned in the first point, you should now use action/checkout@v2. v2 of the Action persists the used authentication token, so other Actions in the Workflow run can execute git commands which interract with GitHub. If you experience problems, you can still overwrite the used token (with a Personal Access Token for example). Checkout the usage documentation of actions/checkout for details.

Added

We've added 3 new options to allow you to customize the commit user and author:

• commit_user_email: Defaults to "[email protected]"
• commit_user_name: Defaults to "GitHub Actions"
• commit_author: Defaults to "github_username [email protected]"

Checkout the action.yml file for more detailed information.

Changes

The branch input option is now optional (again). action/checkout@v2 no longer leaves the repo in a detached HEAD state in Workflows listening to the push-event. This allows us to simply call git push origin to push the changes back to the repository.

However, the branch input option is still required for Workflows which listen to the pull_request event. Checkout the usage examples in the README.

Workflow examples

Following are 2 Workflow examples on how you can use this Action on Workflows which listen to push and pull_request-events.

push-event

name: Format PHP

on: push

jobs:
  php-cs-fixer:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2

    - name: Run php-cs-fixer
      uses: docker://oskarstark/php-cs-fixer-ga

    - uses: stefanzweifel/[email protected]
      with:
        commit_message: Apply php-cs-fixer changes

pull_request-event

name: Format PHP

on: pull_request

jobs:
  php-cs-fixer:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2
      with:
        ref: ${{ github.head_ref }}

    - name: Run php-cs-fixer
      uses: docker://oskarstark/php-cs-fixer-ga

    - uses: stefanzweifel/[email protected]
      with:
        commit_message: Apply php-cs-fixer changes
        branch: ${{ github.head_ref }}

Added

• Add new repository-argument #22

Changed

• Extract logic of the Action into methods and into a separate file #24

• Commit untracked files #19 (fixes #16)
• Add support for Git-LFS #21 (fixes #20)