Tag v4.9.1

Revert "Feature: Create a new branch, if the given branch name doesn't exist yet"

.github/FUNDING.yml

@@ -0,0 +1,2 @@
+github: stefanzweifel
+custom: ["https://buymeacoff.ee/3oQ64YW"]

.github/workflows/linter.yml

@@ -0,0 +1,19 @@
+name: Lint Code Base
+on: push
+
+jobs:
+  build:
+    name: Lint Code Base
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v2
+
+      - name: Lint Code Base
+        uses: github/super-linter@v3
+        env:
+          VALIDATE_ALL_CODEBASE: false
+          VALIDATE_MARKDOWN: false
+          DEFAULT_BRANCH: master
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/shellcheck.yml

@@ -1,12 +0,0 @@
-name: Shellcheck
-
-on: push
-
-jobs:
-  shellcheck:
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/checkout@v1
-
-    - name: shellcheck
-      uses: ludeeus/action-shellcheck@0.1.0

.github/workflows/tests.yml

@@ -0,0 +1,17 @@
+name: tests
+
+on: push
+
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Install testing dependencies
+      run: yarn install
+
+    - name: Run Tests
+      run: yarn test
+

.github/workflows/versioning.yml

@@ -0,0 +1,15 @@
+name: Keep the versions up-to-date
+
+on:
+  release:
+    types: [published, edited]
+
+jobs:
+  actions-tagger:
+    runs-on: windows-latest
+    steps:
+      - uses: Actions-R-Us/actions-tagger@latest
+        env:
+          GITHUB_TOKEN: "${{secrets.GITHUB_TOKEN}}"
+        with:
+          publish_latest_tag: true

.gitignore

@@ -0,0 +1,4 @@
+tests/test_fake_local_repository
+tests/test_fake_remote_repository
+tests/test_fake_temp_local_repository
+yarn.lock

CHANGELOG.md

@@ -4,11 +4,83 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
-## [Unreleased](https://github.com/stefanzweifel/git-auto-commit-action/compare/v4.3.0...HEAD)
+## [Unreleased](https://github.com/stefanzweifel/git-auto-commit-action/compare/v4.9.1...HEAD)
 
 > TBD
 
 
+## [v4.9.1](https://github.com/stefanzweifel/git-auto-commit-action/compare/v4.9.0...v4.9.1) - 2021-02-23
+
+### Changed
+- Revert changes made in v4.9.0. A branch will no longer be automatically generated. [#144](https://github.com/stefanzweifel/git-auto-commit-action/pull/144)
+
+
+## [v4.9.0](https://github.com/stefanzweifel/git-auto-commit-action/compare/v4.8.0...v4.9.0) - 2021-02-20
+
+### Changed
+- Automatically create branch if a branch with the given name does not exist [#140](https://github.com/stefanzweifel/git-auto-commit-action/pull/140)
+
+
+## [v4.8.0](https://github.com/stefanzweifel/git-auto-commit-action/compare/v4.7.2...v4.8.0) - 2020-12-15
+
+### Added
+- Add `skip_fetch` option to skip the execution of `git-fetch` [#131](https://github.com/stefanzweifel/git-auto-commit-action/pull/131)
+
+### Changed
+- Update `git fetch` to only fetch the latest commit from remote [#131](https://github.com/stefanzweifel/git-auto-commit-action/pull/131)
+
+
+## [v4.7.2](https://github.com/stefanzweifel/git-auto-commit-action/compare/v4.7.1...v4.7.2) - 2020-10-24
+
+This release basically reverts the Action to the state of `v4.6.0`.
+
+### Changed
+- Revert change to fix git-checkout with special characters in branch names [#122](https://github.com/stefanzweifel/git-auto-commit-action/pull/122)
+
+
+## [v4.7.1](https://github.com/stefanzweifel/git-auto-commit-action/compare/v4.7.0...v4.7.1) - 2020-10-22
+
+### Removed
+- Remove `checkout_options` as it broke everything [#120](https://github.com/stefanzweifel/git-auto-commit-action/pull/120/)
+
+
+## [v4.7.0](https://github.com/stefanzweifel/git-auto-commit-action/compare/v4.6.0...v4.7.0) - 2020-10-21
+
+### Added
+- Add `checkout_options` [#115](https://github.com/stefanzweifel/git-auto-commit-action/pull/115)
+
+
+## [v4.6.0](https://github.com/stefanzweifel/git-auto-commit-action/compare/v4.5.1...v4.6.0) - 2020-10-11
+
+### Changed
+- Make "commit_message" optional and set default commit message to "Apply automatic changes" [#103](https://github.com/stefanzweifel/git-auto-commit-action/issues/103), [#110](https://github.com/stefanzweifel/git-auto-commit-action/pull/110)
+
+### Fixes
+- Better support for branch names with special characters in them [#108](https://github.com/stefanzweifel/git-auto-commit-action/pull/108)
+
+
+## [v4.5.1](https://github.com/stefanzweifel/git-auto-commit-action/compare/v4.5.0...v4.5.1) - 2020-09-11
+
+### Removed
+- Remove orphan branch feature added in #95 which broke stuff [#98](https://github.com/stefanzweifel/git-auto-commit-action/pull/98)
+
+## [v4.5.0](https://github.com/stefanzweifel/git-auto-commit-action/compare/v4.4.1...v4.5.0) - 2020-09-10
+
+### Added
+- Create orphan branch if branch name does not exist [#95](https://github.com/stefanzweifel/git-auto-commit-action/pull/95)
+
+## [v4.4.1](https://github.com/stefanzweifel/git-auto-commit-action/compare/v4.4.0...v4.4.1) - 2020-08-16
+
+### Changed
+- Include given `file_pattern` in git dirty check [#91](https://github.com/stefanzweifel/git-auto-commit-action/pull/91)
+
+
+## [v4.4.0](https://github.com/stefanzweifel/git-auto-commit-action/compare/v4.3.0...v4.4.0) - 2020-06-26
+
+### Added
+- Add option to skipt the dirty check and always try to create and push a commit [#82](https://github.com/stefanzweifel/git-auto-commit-action/issues/82), [#84](https://github.com/stefanzweifel/git-auto-commit-action/pull/84)
+
+
 ## [v4.3.0](https://github.com/stefanzweifel/git-auto-commit-action/compare/v4.2.0...v4.3.0) - 2020-05-16
 
 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](https://github.com/stefanzweifel/git-auto-commit-action/issues/77) for details.
@@ -19,7 +91,7 @@ Note: Since v4.3.0 we provide major version tags. You can now use `stefanzweifel
 
 ## [v4.2.0](https://github.com/stefanzweifel/git-auto-commit-action/compare/v4.1.6...v4.2.0) - 2020-05-10
 
-### Changed
+### Changed
 - Use `${{ github.head_ref }}` as default branch value. Therefore, the branch name when listening for `pull_request`-events is optional. [#75](https://github.com/stefanzweifel/git-auto-commit-action/pull/75), [#73](https://github.com/stefanzweifel/git-auto-commit-action/pull/73)
 
 
@@ -78,7 +150,7 @@ Note: Since v4.3.0 we provide major version tags. You can now use `stefanzweifel
 ### Added
 - Add `commit_user_name`, `commit_user_email` and `commit_author` input options for full customzation on how the commit is being created [#39](https://github.com/stefanzweifel/git-auto-commit-action/pull/39)
 
-### Changed
+### Changed
 - Make the `branch` input option optional [#41](https://github.com/stefanzweifel/git-auto-commit-action/pull/41)
 
 ### Removed

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2019 Stefan Zweifel
+Copyright (c) 2021 Stefan Zweifel
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -2,45 +2,74 @@
 
 > The GitHub Action for committing files for the 80% use case.
 
+<a href="https://github.com/search?o=desc&q=stefanzweifel%2Fgit-auto-commit-action+path%3A.github%2Fworkflows+language%3AYAML&s=&type=Code" target="_blank" title="Public workflows that use this action."><img src="https://img.shields.io/endpoint?url=https%3A%2F%2Fapi-git-master.endbug.vercel.app%2Fapi%2Fgithub-actions%2Fused-by%3Faction%3Dstefanzweifel%2Fgit-auto-commit-action%26badge%3Dtrue" alt="Public workflows that use this action."></a>
+<a href="https://github.com/stefanzweifel/git-auto-commit-action/actions?query=workflow%3Atests">
+    <img src="https://github.com/stefanzweifel/git-auto-commit-action/workflows/tests/badge.svg" alt="">
+</a>
+
 This GitHub Action automatically commits files which have been changed during a Workflow run and pushes the commit back to GitHub.  
-The default committer is "GitHub Actions <actions@github.com>", and the default author of the commit is "Your GitHub Username <github_username@users.noreply.github.com>".
+By default, the commit is made in the name of "GitHub Actions" and co-authored by the user that made the last commit.
 
 This Action has been inspired and adapted from the [auto-commit](https://github.com/cds-snc/github-actions/tree/master/auto-commit
 )-Action of the Canadian Digital Service and this [commit](https://github.com/elstudio/actions-js-build/blob/41d604d6e73d632e22eac40df8cc69b5added04b/commit/entrypoint.sh)-Action by Eric Johnson.
 
+If you want to learn more how this Action works under the hood, check out [this article](https://michaelheap.com/git-auto-commit/) by Michael Heap.
+
 ## Usage
 
 Add the following step at the end of your job, after other steps that might add or change files.
 
+```yaml
+- uses: stefanzweifel/git-auto-commit-action@v4
+```
+
+
+This is a more extended example with all possible options.
+
 ```yaml
 - uses: stefanzweifel/git-auto-commit-action@v4
   with:
-    # Required
+    # Optional but recommended
+    # Defaults to "Apply automatic changes"
     commit_message: Apply automatic changes
 
-    # Optional branch to push to, defaults to the current branch
+    # Optional branch name where commit should be pushed to
+    # Defaults to the current branch
     branch: feature-123
 
     # Optional options appended to `git-commit`
+    # See https://git-scm.com/docs/git-commit for a list of available options
     commit_options: '--no-verify --signoff'
 
     # Optional glob pattern of files which should be added to the commit
-    file_pattern: src/*.js tests/*.js
+    # Defaults to all (.)
+    # See the `pathspec`-documentation for git
+    # - https://git-scm.com/docs/git-add#Documentation/git-add.txt-ltpathspecgt82308203
+    # - https://git-scm.com/docs/gitglossary#Documentation/gitglossary.txt-aiddefpathspecapathspec
+    file_pattern: src/*.js tests/*.js *.php
 
     # Optional local file path to the repository
+    # Defaults to the root of the repository
     repository: .
 
     # Optional commit user and author settings
-    commit_user_name: My GitHub Actions Bot
-    commit_user_email: my-github-actions-bot@example.org
-    commit_author: Author <actions@github.com>
+    commit_user_name: My GitHub Actions Bot # defaults to "GitHub Actions"
+    commit_user_email: my-github-actions-bot@example.org # defaults to "actions@github.com"
+    commit_author: Author <actions@github.com> # defaults to author of the commit that triggered the run
 
     # Optional tag message 
     # Action will create and push a new tag to the remote repository and the defined branch
     tagging_message: 'v1.0.0'
 
     # Optional options appended to `git-push`
+    # See git-push documentation for details: https://git-scm.com/docs/git-push#_options
     push_options: '--force'
+    
+    # Optional: Disable dirty check and always try to create a commit and push
+    skip_dirty_check: true    
+    
+    # Optional: Skip internal call to `git fetch`
+    skip_fetch: true
 ```
 
 ## Example
@@ -57,7 +86,7 @@ on:
   pull_request:
   push:
     branches:
-      - "master"
+      - "main"
 
 jobs:
   php-cs-fixer:
@@ -76,6 +105,28 @@ jobs:
         commit_message: Apply php-cs-fixer changes
 ```
 
+## Inputs
+
+Checkout [`action.yml`](https://github.com/stefanzweifel/git-auto-commit-action/blob/master/action.yml) for a full list of supported inputs.
+
+## Outputs
+
+You can use these outputs to trigger other Actions in your Workflow run based on the result of `git-auto-commit-action`.
+
+- `changes_detected`: Returns either "true" or "false" if the repository was dirty and files have changed.
+
+### Example
+
+```yaml
+  - name: "Run if changes have been detected"
+    if: steps.auto-commit-action.outputs.changes_detected == 'true'
+    run: echo "Changes!"
+
+  - name: "Run if no changes have been detected"
+    if: steps.auto-commit-action.outputs.changes_detected == 'false'
+    run: echo "No Changes!"
+```
+
 ## Limitations & Gotchas
 
 ### Checkout the correct branch
@@ -89,41 +140,95 @@ In non-`push` events, such as `pull_request`, make sure to specify the `ref` to
     ref: ${{ github.head_ref }}
 ```
 
-You have to do this do avoid that the `checkout`-Action clones your repository in a detached state.
+You have to do this to avoid that the `checkout`-Action clones your repository in a detached state.
 
 ### Commits of this Action do not trigger new Workflow runs
 
 The resulting commit **will not trigger** another GitHub Actions Workflow run.
-This is due to [limititations set by GitHub](https://help.github.com/en/actions/reference/events-that-trigger-workflows#triggering-new-workflows-using-a-personal-access-token).
+This is due to [limitations set by GitHub](https://help.github.com/en/actions/reference/events-that-trigger-workflows#triggering-new-workflows-using-a-personal-access-token).
 
 > When you use the repository's GITHUB_TOKEN to perform tasks on behalf of the GitHub Actions app, events triggered by the GITHUB_TOKEN will not create a new workflow run. This prevents you from accidentally creating recursive workflow runs.
 
 You can change this by creating a new [Personal Access Token (PAT)](https://github.com/settings/tokens/new),
-storing the token as a secret in your repository and then passing the new token to the [`actions/checkout`](https://github.com/actions/checkout#usage) Action.
+storing the token as a secret in your repository and then passing the new token to the [`actions/checkout`](https://github.com/actions/checkout#usage) Action step.
 
 ```yaml
 - uses: actions/checkout@v2
   with:
-    token: ${{ secrets.PAT_TOKEN }}
+    token: ${{ secrets.PAT }}
 ```
 
-### Unable to commit into PRs from forks
+If you work in an organization and don't want to create a PAT from your personal account, we recommend using a [robot account](https://docs.github.com/en/github/getting-started-with-github/types-of-github-accounts) for the token.
 
-GitHub currently prohibits Actions to push commits to forks, even when they created a PR and allow edits.
-See [issue #25](https://github.com/stefanzweifel/git-auto-commit-action/issues/25) for more information.
 
-## Inputs
+### Using the Action in forks from public repositories
 
-Checkout [`action.yml`](https://github.com/stefanzweifel/git-auto-commit-action/blob/master/action.yml) for a full list of supported inputs.
+**☝️ Important Notice**: This Action technically works with forks. However, please note that the combination of triggers and their options can cause issues. Please read [the documentation](https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows) on which triggers GitHub Actions support.\
+If you use this Action in combination with a linter/fixer, it's easier if you run the Action on `push` on your `main`-branch.
 
-## Outputs
+---
 
-You can use these outputs to trigger other Actions in your Workflow run based on the result of `git-auto-commit-action`.
+By default, this Action will not run on Pull Requests which have been opened by forks. (This is a limitation by GitHub, not by us.)
+
+If you want that a Workflow using this Action runs on Pull Requests opened by forks, 2 things have to be changed:
+
+1. In addition to listening to the `pull_request` event in your Workflow triggers, you have to add an additional event: `pull_request_target`. You can learn more about this event in [the GitHub docs](https://docs.github.com/en/actions/reference/events-that-trigger-workflows#pull_request_target).
+2. GitHub Action has to be enabled on the forked repository. \
+For security reasons, GitHub does not automatically enable GitHub Actions on forks. The user has to explicitly enable GitHub Actions in the "Actions"-tab of the forked repository. (Mention this in your projects README or CONTRIBUTING.md!)
+
+After you have added the `pull_request_target` to your desired Workflow and the forked repository has enabled Actions and a new Pull Request is opened, the Workflow will run **on the forked repository**.
+
+Due to the fact that the Workflow is not run on the repository the Pull Request is opened in, you won't see any status indicators inside the Pull Request.
+
+#### Example
+
+The following workflow runs `php-cs-fixer` (a code linter and fixer for PHP) when a `pull_request` is opened. We've added the `pull_request_target`-trigger too, to make it work for forks.
+
+```yaml
+name: Format PHP
+
+on: [push, pull_request, pull_request_target]
+
+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/git-auto-commit-action@v4
+      with:
+        commit_message: Apply php-cs-fixer changes
+```
+
+Next time a user forks your project **and** enabled GitHub Actions **and** opened a Pull Request, the Workflow will run on the the forked repository and will push commits to the same branch.
+
+Here's how the Pull Request will look like:
+
+![Screenshot of a Pull Request from a Fork](https://user-images.githubusercontent.com/1080923/90955964-9c74c080-e482-11ea-8097-aa7f5161f50e.png)
+
+
+As you can see, your contributors have to go through hoops to make this work. **For Workflows which runter linters and fixers (like the example above) we recommend running them when a push happens on the `master`-branch.**
+
+
+For more information about running Actions on forks, see [this announcement from GitHub](https://github.blog/2020-08-03-github-actions-improvements-for-fork-and-pull-request-workflows/).
+
+### Push to forks from private repositories
+
+By default, GitHub Actions doesn't run Workflows on forks from private repositories. To enable Actions for **private** repositories enable "Run workflows from pull requests" in your repository settings.
+
+See [this announcement from GitHub](https://github.blog/2020-08-03-github-actions-improvements-for-fork-and-pull-request-workflows/) or the [GitHub docs](https://docs.github.com/en/github/administering-a-repository/disabling-or-limiting-github-actions-for-a-repository#enabling-workflows-for-private-repository-forks) for details.
+
+### Signing Commits & Other Git Command Line Options
+
+Using command lines options needs to be done manually for each workflow which you require the option enabled. So for example signing commits requires you to import the gpg signature each and every time. The following list of actions are worth checking out if you need to automate these tasks regulary
+
+- [Import GPG Signature](https://github.com/crazy-max/ghaction-import-gpg) (Suggested by [TGTGamer](https://github.com/tgtgamer))
 
-- `changes_detected`: Returns either "true" or "false" if the repository was dirty and files have changed.
 
 ## Troubleshooting
-
 ### Action does not push commit to repository
 
 Make sure to [checkout the correct branch](#checkout-the-correct-branch).
@@ -135,11 +240,11 @@ please update your Workflow configuration and usage of [`actions/checkout`](http
 
 Updating the `token` value with a Personal Access Token should fix your issues.
 
-## Action does not push to protected branch
+### Push to protected branches
 
-If your repository uses [protected branches](https://help.github.com/en/github/administering-a-repository/configuring-protected-branches) this Action will not be able to push to your repository.
+If your repository uses [protected branches](https://help.github.com/en/github/administering-a-repository/configuring-protected-branches) you have to do the following changes to your Workflow for the Action to work properly.
 
-You have to enable force pushes to a protected branch (See [documentation](https://help.github.com/en/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)) and update your Workflow to use force push like so.
+You have to enable force pushes to a protected branch (See [documentation](https://help.github.com/en/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)) and update your Workflow to use force push like this.
 
 ```yaml
     - uses: stefanzweifel/git-auto-commit-action@v4
@@ -148,16 +253,44 @@ You have to enable force pushes to a protected branch (See [documentation](https
         push_options: --force
 ```
 
+In addition, you have to create a new [Personal Access Token (PAT)](https://github.com/settings/tokens/new),
+store the token as a secret in your repository and pass the new token to the [`actions/checkout`](https://github.com/actions/checkout#usage) Action step.
+
+```yaml
+- uses: actions/checkout@v2
+  with:
+    token: ${{ secrets.PAT }}
+```
+You can learn more about Personal Access Token in the [GitHub documentation](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token).
+
+Note: If you're working in an organisation and you don't want to create the PAT from your personal account, we recommend using a bot-account for such tokens.
+
 ### No new workflows are triggered by the commit of this action
 
 This is due to limitations set up by GitHub, [commits of this Action do not trigger new Workflow runs](#commits-of-this-action-do-not-trigger-new-workflow-runs).
 
+## Running the tests
+
+The package has tests written in [bats](https://github.com/bats-core/bats-core). Before you can run the test suite locally, you have to install the dependencies with `npm` or `yarn`.
+
+```shell
+npm install
+yarn
+```
+
+You can run the test suite with `npm` or `yarn`.
+
+```shell
+npm run test
+yarn test
+```
+
 ## Versioning
 
 We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/stefanzweifel/git-auto-commit-action/tags).
 
 We also provide major version tags to make it easier to always use the latest release of a major version. For example you can use `stefanzweifel/git-auto-commit-action@v4` to always use the latest release of the current major version.
-(More information about this [here](https://github.com/actions/toolkit/blob/master/docs/action-versioning.md#major-versions).)
+(More information about this [here](https://help.github.com/en/actions/building-actions/about-actions#versioning-your-action).)
 
 ## License
 

action.yml

@@ -6,7 +6,8 @@ author: Stefan Zweifel <hello@stefanzweifel.io>
 inputs:
   commit_message:
     description: Commit message
-    required: true
+    required: false
+    default: Apply automatic changes
   branch:
     description: Git branch name, where changes should be pushed too. Required if Action is used on the `pull_request` event
     required: false
@@ -43,6 +44,14 @@ inputs:
     description: Push options (eg. --force)
     required: false
     default: ''
+  skip_dirty_check:
+    description: Skip the check if the git repository is dirty and always try to create a commit.
+    required: false
+    default: false
+  skip_fetch:
+    description: Skip the call to git-fetch.
+    required: false
+    default: false
 
 outputs:
   changes_detected:

entrypoint.sh

@@ -5,7 +5,7 @@ set -eu
 _main() {
     _switch_to_repository
 
-    if _git_is_dirty; then
+    if _git_is_dirty || "$INPUT_SKIP_DIRTY_CHECK"; then
 
         echo "::set-output name=changes_detected::true";
 
@@ -29,22 +29,34 @@ _main() {
 
 _switch_to_repository() {
     echo "INPUT_REPOSITORY value: $INPUT_REPOSITORY";
-    cd $INPUT_REPOSITORY;
+    cd "$INPUT_REPOSITORY";
 }
 
 _git_is_dirty() {
-    [ -n "$(git status -s)" ]
+    # shellcheck disable=SC2086
+    [ -n "$(git status -s -- $INPUT_FILE_PATTERN)" ]
 }
 
 _switch_to_branch() {
     echo "INPUT_BRANCH value: $INPUT_BRANCH";
 
+    # Fetch remote to make sure that repo can be switched to the right branch.
+
+    if "$INPUT_SKIP_FETCH"; then
+        echo "::debug::git-fetch has not been executed";
+    else
+        git fetch --depth=1;
+    fi
+
     # Switch to branch from current Workflow run
+    # shellcheck disable=SC2086
     git checkout $INPUT_BRANCH;
 }
 
 _add_files() {
     echo "INPUT_FILE_PATTERN: ${INPUT_FILE_PATTERN}";
+
+    # shellcheck disable=SC2086
     git add ${INPUT_FILE_PATTERN};
 }
 
@@ -52,8 +64,14 @@ _local_commit() {
     echo "INPUT_COMMIT_OPTIONS: ${INPUT_COMMIT_OPTIONS}";
     echo "::debug::Apply commit options ${INPUT_COMMIT_OPTIONS}";
 
+    # shellcheck disable=SC2206
     INPUT_COMMIT_OPTIONS_ARRAY=( $INPUT_COMMIT_OPTIONS );
 
+    echo "INPUT_COMMIT_USER_NAME: ${INPUT_COMMIT_USER_NAME}";
+    echo "INPUT_COMMIT_USER_EMAIL: ${INPUT_COMMIT_USER_EMAIL}";
+    echo "INPUT_COMMIT_MESSAGE: ${INPUT_COMMIT_MESSAGE}";
+    echo "INPUT_COMMIT_AUTHOR: ${INPUT_COMMIT_AUTHOR}";
+
     git -c user.name="$INPUT_COMMIT_USER_NAME" -c user.email="$INPUT_COMMIT_USER_EMAIL" \
         commit -m "$INPUT_COMMIT_MESSAGE" \
         --author="$INPUT_COMMIT_AUTHOR" \
@@ -68,7 +86,7 @@ _tag_commit() {
         echo "::debug::Create tag $INPUT_TAGGING_MESSAGE";
         git -c user.name="$INPUT_COMMIT_USER_NAME" -c user.email="$INPUT_COMMIT_USER_EMAIL" tag -a "$INPUT_TAGGING_MESSAGE" -m "$INPUT_TAGGING_MESSAGE";
     else
-        echo " No tagging message supplied. No tag will be added.";
+        echo "No tagging message supplied. No tag will be added.";
     fi
 }
 
@@ -77,6 +95,7 @@ _push_to_github() {
     echo "INPUT_PUSH_OPTIONS: ${INPUT_PUSH_OPTIONS}";
     echo "::debug::Apply push options ${INPUT_PUSH_OPTIONS}";
 
+    # shellcheck disable=SC2206
     INPUT_PUSH_OPTIONS_ARRAY=( $INPUT_PUSH_OPTIONS );
 
     if [ -z "$INPUT_BRANCH" ]

package.json

@@ -0,0 +1,10 @@
+{
+  "devDependencies": {
+    "bats": "^1.1.0",
+    "bats-assert": "ztombol/bats-assert",
+    "bats-support": "ztombol/bats-support"
+  },
+  "scripts": {
+    "test": "bats tests"
+  }
+}

tests/git-auto-commit.bats

@@ -0,0 +1,333 @@
+#!/usr/bin/env bats
+
+load '../node_modules/bats-support/load'
+load '../node_modules/bats-assert/load'
+
+setup() {
+    # Define Paths for local repository used during tests
+    export FAKE_LOCAL_REPOSITORY="${BATS_TEST_DIRNAME}/tests_local_repository"
+    export FAKE_REMOTE="${BATS_TEST_DIRNAME}/tests_remote_repository"
+    export FAKE_TEMP_LOCAL_REPOSITORY="${BATS_TEST_DIRNAME}/tests_clone_of_remote_repository"
+
+    # Set default INPUT variables used by the GitHub Action
+    export INPUT_REPOSITORY="${FAKE_LOCAL_REPOSITORY}"
+    export INPUT_COMMIT_MESSAGE="Commit Message"
+    export INPUT_BRANCH="master"
+    export INPUT_COMMIT_OPTIONS=""
+    export INPUT_FILE_PATTERN="."
+    export INPUT_COMMIT_USER_NAME="Test Suite"
+    export INPUT_COMMIT_USER_EMAIL="test@github.com"
+    export INPUT_COMMIT_AUTHOR="Test Suite <test@users.noreply.github.com>"
+    export INPUT_TAGGING_MESSAGE=""
+    export INPUT_PUSH_OPTIONS=""
+    export INPUT_SKIP_DIRTY_CHECK=false
+    export INPUT_SKIP_FETCH=false
+
+    # Configure Git
+    if [[ -z $(git config user.name) ]]; then
+        git config --global user.name "Test Suite"
+        git config --global user.email "test@github.com"
+    fi
+
+    # Create and setup some fake repositories for testing
+    _setup_fake_remote_repository
+    _setup_local_repository
+}
+
+teardown() {
+    rm -rf "${FAKE_LOCAL_REPOSITORY}"
+    rm -rf "${FAKE_REMOTE}"
+    rm -rf "${FAKE_TEMP_LOCAL_REPOSITORY}"
+}
+
+# Create a fake remote repository which tests can push against
+_setup_fake_remote_repository() {
+    # Create the bare repository, which will act as our remote/origin
+    rm -rf "${FAKE_REMOTE}";
+    mkdir "${FAKE_REMOTE}";
+    cd "${FAKE_REMOTE}";
+    git init --bare;
+
+    # Clone the remote repository to a temporary location.
+    rm -rf "${FAKE_TEMP_LOCAL_REPOSITORY}"
+    git clone "${FAKE_REMOTE}" "${FAKE_TEMP_LOCAL_REPOSITORY}"
+
+    # Create some files, commit them and push them to the remote repository
+    touch "${FAKE_TEMP_LOCAL_REPOSITORY}"/remote-files{1,2,3}.txt
+    cd "${FAKE_TEMP_LOCAL_REPOSITORY}";
+    git add .;
+    git commit --quiet -m "Init Remote Repository";
+    git push origin master;
+}
+
+# Clone our fake remote repository and set it up for testing
+_setup_local_repository() {
+    # Clone remote repository. In this repository we will do our testing
+    rm -rf "${FAKE_LOCAL_REPOSITORY}"
+    git clone "${FAKE_REMOTE}" "${FAKE_LOCAL_REPOSITORY}"
+
+    cd "${FAKE_LOCAL_REPOSITORY}";
+}
+
+# Run the main code related to this GitHub Action
+git_auto_commit() {
+    bash "${BATS_TEST_DIRNAME}"/../entrypoint.sh
+}
+
+@test "It detects changes, commits them and pushes them to the remote repository" {
+    touch "${FAKE_LOCAL_REPOSITORY}"/new-file-{1,2,3}.txt
+
+    run git_auto_commit
+
+    assert_success
+
+    assert_line "INPUT_REPOSITORY value: ${INPUT_REPOSITORY}"
+    assert_line "::set-output name=changes_detected::true"
+    assert_line "INPUT_BRANCH value: master"
+    assert_line "INPUT_FILE_PATTERN: ."
+    assert_line "INPUT_COMMIT_OPTIONS: "
+    assert_line "::debug::Apply commit options "
+    assert_line "INPUT_TAGGING_MESSAGE: "
+    assert_line "No tagging message supplied. No tag will be added."
+    assert_line "INPUT_PUSH_OPTIONS: "
+    assert_line "::debug::Apply push options "
+    assert_line "::debug::Push commit to remote branch master"
+}
+
+@test "It detects when files have been deleted, commits changes and pushes them to the remote repository" {
+    rm -rf "${FAKE_LOCAL_REPOSITORY}"/remote-files1.txt
+
+    run git_auto_commit
+
+    assert_success
+
+    assert_line "INPUT_REPOSITORY value: ${INPUT_REPOSITORY}"
+    assert_line "::set-output name=changes_detected::true"
+    assert_line "INPUT_BRANCH value: master"
+    assert_line "INPUT_FILE_PATTERN: ."
+    assert_line "INPUT_COMMIT_OPTIONS: "
+    assert_line "::debug::Apply commit options "
+    assert_line "INPUT_TAGGING_MESSAGE: "
+    assert_line "No tagging message supplied. No tag will be added."
+    assert_line "INPUT_PUSH_OPTIONS: "
+    assert_line "::debug::Apply push options "
+    assert_line "::debug::Push commit to remote branch master"
+}
+
+@test "It prints a 'Nothing to commit' message in a clean repository" {
+    run git_auto_commit
+
+    assert_success
+
+    assert_line "INPUT_REPOSITORY value: ${INPUT_REPOSITORY}"
+    assert_line "::set-output name=changes_detected::false"
+    assert_line "Working tree clean. Nothing to commit."
+}
+
+@test "If SKIP_DIRTY_CHECK is set to true on a clean repo it fails to push" {
+    INPUT_SKIP_DIRTY_CHECK=true
+
+    run git_auto_commit
+
+    assert_failure
+
+    assert_line "INPUT_REPOSITORY value: ${INPUT_REPOSITORY}"
+    assert_line "::set-output name=changes_detected::true"
+
+    assert_line "::set-output name=changes_detected::true"
+    assert_line "INPUT_BRANCH value: master"
+    assert_line "INPUT_FILE_PATTERN: ."
+    assert_line "INPUT_COMMIT_OPTIONS: "
+    assert_line "::debug::Apply commit options "
+}
+
+@test "It applies INPUT_FILE_PATTERN when creating commit" {
+    INPUT_FILE_PATTERN="*.txt *.html"
+
+    touch "${FAKE_LOCAL_REPOSITORY}"/new-file-{1,2}.php
+    touch "${FAKE_LOCAL_REPOSITORY}"/new-file-{1,2}.html
+
+    run git_auto_commit
+
+    assert_success
+
+    assert_line "INPUT_FILE_PATTERN: *.txt *.html"
+    assert_line "::debug::Push commit to remote branch master"
+
+    # Assert that PHP files have not been added.
+    run git status
+    assert_output --partial 'new-file-1.php'
+}
+
+@test "It applies INPUT_COMMIT_OPTIONS when creating commit" {
+    INPUT_COMMIT_OPTIONS="--no-verify --signoff"
+
+    touch "${FAKE_LOCAL_REPOSITORY}"/new-file-{1,2}.txt
+
+    run git_auto_commit
+
+    assert_success
+
+    assert_line "INPUT_COMMIT_OPTIONS: --no-verify --signoff"
+    assert_line "::debug::Push commit to remote branch master"
+
+    # Assert last commit was signed off
+    run git log -n 1
+    assert_output --partial "Signed-off-by:"
+}
+
+@test "It applies commit user and author settings" {
+    INPUT_COMMIT_USER_NAME="A Single Test"
+    INPUT_COMMIT_USER_EMAIL="single-test@github.com"
+    INPUT_COMMIT_AUTHOR="A Single Test <single@users.noreply.github.com>"
+
+    touch "${FAKE_LOCAL_REPOSITORY}"/new-file-{1,2}.txt
+
+    run git_auto_commit
+
+    assert_success
+
+    assert_line "INPUT_COMMIT_USER_NAME: A Single Test";
+    assert_line "INPUT_COMMIT_USER_EMAIL: single-test@github.com";
+    assert_line "INPUT_COMMIT_AUTHOR: A Single Test <single@users.noreply.github.com>";
+    assert_line "::debug::Push commit to remote branch master"
+
+    # Asser last commit was made by the defined user/author
+    run git log -1 --pretty=format:'%ae'
+    assert_output --partial "single@users.noreply.github.com"
+
+    run git log -1 --pretty=format:'%an'
+    assert_output --partial "A Single Test"
+
+    run git log -1 --pretty=format:'%cn'
+    assert_output --partial "A Single Test"
+
+    run git log -1 --pretty=format:'%ce'
+    assert_output --partial "single-test@github.com"
+}
+
+@test "It creates a tag with the commit" {
+    INPUT_TAGGING_MESSAGE="v1.0.0"
+
+    touch "${FAKE_LOCAL_REPOSITORY}"/new-file-{1,2,3}.txt
+
+    run git_auto_commit
+
+    assert_success
+
+    assert_line "INPUT_TAGGING_MESSAGE: v1.0.0"
+    assert_line "::debug::Create tag v1.0.0"
+    assert_line "::debug::Push commit to remote branch master"
+
+    # Assert a tag v1.0.0 has been created
+    run git tag
+    assert_output v1.0.0
+
+    run git ls-remote --tags --refs
+    assert_output --partial refs/tags/v1.0.0
+}
+
+@test "It applies INPUT_PUSH_OPTIONS when pushing commit to remote" {
+
+    touch "${FAKE_TEMP_LOCAL_REPOSITORY}"/newer-remote-files{1,2,3}.txt
+    cd "${FAKE_TEMP_LOCAL_REPOSITORY}";
+    git add .;
+    git commit --quiet -m "Add more remote files";
+    git push origin master;
+
+
+    INPUT_PUSH_OPTIONS="--force"
+
+    touch "${FAKE_LOCAL_REPOSITORY}"/new-file-{1,2,3}.txt
+
+    run git_auto_commit
+
+    assert_success
+
+    assert_line "INPUT_PUSH_OPTIONS: --force"
+    assert_line "::debug::Apply push options --force"
+    assert_line "::debug::Push commit to remote branch master"
+
+    # Assert that the commit has been pushed with --force and
+    # sha values are equal on local and remote
+    current_sha="$(git rev-parse --verify --short master)"
+    remote_sha="$(git rev-parse --verify --short origin/master)"
+
+    assert_equal $current_sha $remote_sha
+}
+
+@test "It can checkout a different branch" {
+    # Create foo-branch and then immediately switch back to master
+    git checkout -b foo
+    git checkout master
+
+    INPUT_BRANCH="foo"
+
+    touch "${FAKE_LOCAL_REPOSITORY}"/new-file-{1,2,3}.txt
+
+    run git_auto_commit
+
+    assert_success
+
+    assert_line "INPUT_BRANCH value: foo"
+    assert_line "::debug::Push commit to remote branch foo"
+
+    # Assert a new branch "foo" exists on remote
+    run git ls-remote --heads
+    assert_output --partial refs/heads/foo
+}
+
+@test "It uses existing branch name when pushing when INPUT_BRANCH is empty" {
+    INPUT_BRANCH=""
+
+    touch "${FAKE_LOCAL_REPOSITORY}"/new-file-{1,2,3}.txt
+
+    run git_auto_commit
+
+    assert_success
+
+    assert_line "INPUT_BRANCH value: "
+    assert_line --partial "::debug::git push origin"
+
+    # Assert that branch "master" was updated on remote
+    current_sha="$(git rev-parse --verify --short master)"
+    remote_sha="$(git rev-parse --verify --short origin/master)"
+
+    assert_equal $current_sha $remote_sha
+}
+
+@test "It uses existing branch when INPUT_BRANCH is empty and INPUT_TAGGING_MESSAGE is set" {
+    INPUT_BRANCH=""
+    INPUT_TAGGING_MESSAGE="v2.0.0"
+
+    touch "${FAKE_LOCAL_REPOSITORY}"/new-file-{1,2,3}.txt
+
+    run git_auto_commit
+
+    assert_success
+
+    assert_line "INPUT_TAGGING_MESSAGE: v2.0.0"
+    assert_line "::debug::Create tag v2.0.0"
+    assert_line "::debug::git push origin --tags"
+
+    # Assert a tag v2.0.0 has been created
+    run git tag
+    assert_output v2.0.0
+
+    # Assert tag v2.0.0 has been pushed to remote
+    run git ls-remote --tags --refs
+    assert_output --partial refs/tags/v2.0.0
+}
+
+@test "If SKIP_FETCH is true git-fetch will not be called" {
+
+    touch "${FAKE_LOCAL_REPOSITORY}"/new-file-{1,2,3}.txt
+
+    INPUT_SKIP_FETCH=true
+
+    run git_auto_commit
+
+    assert_success
+
+    assert_line "::debug::git-fetch has not been executed"
+}

yarn.lock

@@ -0,0 +1,16 @@
+# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
+# yarn lockfile v1
+
+
+bats-assert@ztombol/bats-assert:
+  version "0.3.0"
+  resolved "https://codeload.github.com/ztombol/bats-assert/tar.gz/9f88b4207da750093baabc4e3f41bf68f0dd3630"
+
+bats-support@ztombol/bats-support:
+  version "0.3.0"
+  resolved "https://codeload.github.com/ztombol/bats-support/tar.gz/004e707638eedd62e0481e8cdc9223ad471f12ee"
+
+bats@^1.1.0:
+  version "1.2.1"
+  resolved "https://registry.yarnpkg.com/bats/-/bats-1.2.1.tgz#c15aecc3eb331aedf28678880fab2be0b73eba43"
+  integrity sha512-2fcPDRQa/Kvh6j1IcCqsHpT5b9ObMzRzw6abC7Bg298PX8Qdh9VRkvO2WJUEhdyfjq2rLBCOAWdcv0tS4+xTUA==