Release v4.4.1

Only check status of files matching file_pattern

.github/FUNDING.yml

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

.github/ISSUE_TEMPLATE/bug_report.md

@@ -7,8 +7,10 @@ assignees: ''
 
 ---
 
+<!-- Before opening an issue, have you tried solving your problem by explicitly setting the `branch`-value in your workflow? -->
+
 **Version of the Action**
-`v2.x.x`
+`v4.x.x`
 
 **Describe the bug**
 A clear and concise description of what the bug is.
@@ -26,5 +28,11 @@ A clear and concise description of what you expected to happen.
 **Screenshots**
 If applicable, add screenshots to help explain your problem.
 
+**Used Workflow**
+
+```yaml
+# Paste the Workflow you've used here
+```
+
 **Additional context**
 Add any other context about the problem here.

.github/workflows/continuous-deployment.yml

@@ -1,31 +0,0 @@
-# https://help.github.com/en/categories/automating-your-workflow-with-github-actions
-
-name: "Continuous Deployment"
-
-on:
-  push:
-    tags:
-      - "**"
-
-jobs:
-  release:
-    name: "Release"
-
-    runs-on: "ubuntu-latest"
-
-    steps:
-      - name: "Determine tag"
-        id: "determine-tag"
-        run: "echo \"::set-output name=tag::${GITHUB_REF#refs/tags/}\""
-
-      - name: "Create release"
-        uses: "actions/create-release@v1.0.0"
-        env:
-          GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
-        with:
-          draft: false
-          prerelease: false
-          body: |
-            See [Changelog](https://github.com/stefanzweifel/git-auto-commit-action/blob/master/CHANGELOG.md) for details.
-          release_name: "${{ steps.determine-tag.outputs.tag }}"
-          tag_name: "${{ steps.determine-tag.outputs.tag }}"

.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

CHANGELOG.md

@@ -4,10 +4,37 @@ 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.1.6...HEAD)
+## [Unreleased](https://github.com/stefanzweifel/git-auto-commit-action/compare/v4.4.1...HEAD)
 
 > TBD
 
+
+## [v4.4.1](https://github.com/stefanzweifel/git-auto-commit-action/compare/v4.4.0...v4.4.1) - 2020-08-016
+
+### 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.
+
+### Added
+- Add new `push_options`-input. This feature makes it easier for you to force-push commits to a repository. [#78](https://github.com/stefanzweifel/git-auto-commit-action/pull/78), [#72](https://github.com/stefanzweifel/git-auto-commit-action/issues/72)
+
+
+## [v4.2.0](https://github.com/stefanzweifel/git-auto-commit-action/compare/v4.1.6...v4.2.0) - 2020-05-10
+
+### 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)
+
+
 ## [v4.1.6](https://github.com/stefanzweifel/git-auto-commit-action/compare/v4.1.5...v4.1.6) - 2020-04-28
 
 ### Fixes
@@ -63,7 +90,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 ### 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

README.md

@@ -1,34 +1,34 @@
-# git-auto-commit-action
+# git-auto-commit Action
 
-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>".
+> The GitHub Action for committing files for the 80% use case.
 
-If no changes are detected, the Action does nothing.
+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>".
 
 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.
 
-*This Action currently can't be used in conjunction with pull requests of forks. See [issue #25](https://github.com/stefanzweifel/git-auto-commit-action/issues/25) for more information.*
-
 ## Usage
 
-**Note:** This Action requires that you use `action/checkout@v2` or above to checkout your repository.
-
-Add the following step at the end of your job.
+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.1.6
+- uses: stefanzweifel/git-auto-commit-action@v4
   with:
+    # Required
     commit_message: Apply automatic changes
 
-    # Optional name of the branch the commit should be pushed to
-    # Required if Action is used in Workflow listening to the `pull_request` event
-    branch: ${{ github.head_ref }}
+    # Optional branch to push to, defaults to the current branch
+    branch: feature-123
 
-    # Optional git params
+    # 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
+    # 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
 
     # Optional local file path to the repository
@@ -39,30 +39,32 @@ Add the following step at the end of your job.
     commit_user_email: my-github-actions-bot@example.org
     commit_author: Author <actions@github.com>
 
-    # Optional tag message. Will create and push a new tag to the remote repository
+    # 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`
+    push_options: '--force'
+    
+    # Optional: Disable dirty check and always try to create a commit and push
+    skip_dirty_check: true
 ```
 
-The Action will only commit files back, if changes are available. The resulting commit **will not trigger** another GitHub Actions Workflow run!
+## Example
 
-We recommend to use this Action in Workflows, which listen to the `pull_request` event. You can then use the option `branch: ${{ github.head_ref }}` to set up the branch name correctly.
-If you don't pass a branch name, the Action will try to push the commit to a branch with the same name, as with which the repo has been checked out.
+In this example, we're running `php-cs-fixer` in a PHP project to fix the codestyle automatically, then commit possible changed files back to the repository.
 
-## Example Usage
-
-This Action will only work, if the job in your Workflow changes files.
-The most common use case for this, is when you're running a Linter or Code-Style fixer on GitHub Actions.
-
-In this example I'm running `php-cs-fixer` in a PHP project.
-
-### Example on `pull_request` event
-
-If you would like to use this Action in a Workflow which listens to the `pull_request` event, you must add the `ref`-input to the `actions/checkout@v2` step. It's also recommended to add the `branch`-input to the `git-auto-commit`-step. This way you tell the Action exactly where to push the commit.
+Note that we explicitly specify `${{ github.head_ref }}` in the checkout Action.
+This is required in order to work with the `pull_request` event (or any other non-`push` event).
 
 ```yaml
 name: php-cs-fixer
 
-on: pull_request
+on:
+  pull_request:
+  push:
+    branches:
+      - "master"
 
 jobs:
   php-cs-fixer:
@@ -76,90 +78,111 @@ jobs:
     - name: Run php-cs-fixer
       uses: docker://oskarstark/php-cs-fixer-ga
 
-    - uses: stefanzweifel/git-auto-commit-action@v4.1.6
-      with:
-        commit_message: Apply php-cs-fixer changes
-        branch: ${{ github.head_ref }}
-```
-
-### Example on `push` event
-
-```yaml
-name: php-cs-fixer
-
-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/git-auto-commit-action@v4.1.6
+    - uses: stefanzweifel/git-auto-commit-action@v4
       with:
         commit_message: Apply php-cs-fixer changes
 ```
 
-### Inputs
+## 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.
 
-## Troubleshooting
+## Limitations & Gotchas
 
-### Can't push commit to repository
-If your Workflow can't push the commit to the repository because of authentication issues, please update your Workflow configuration and usage of [`actions/checkout`](https://github.com/actions/checkout#usage). (Updating the `token` value with a Personal Access Token should fix your issues)
+### Checkout the correct branch
 
-### Commit of this Action does not trigger a new Workflow run
-As mentioned in the [Usage](#Usage) section, the commit created by this Action **will not trigger** a new Workflow run automatically.
-
-This is due to limitations set up by GitHub:
-
-> An action in a workflow run can't trigger a new workflow run. For example, if an action pushes code using the repository's GITHUB_TOKEN, a new workflow will not run even when the repository contains a workflow configured to run when push events occur.
-[Source](https://help.github.com/en/actions/reference/events-that-trigger-workflows)
-
-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.
-
-#### Example Workflow
+You must use `action/checkout@v2` or later versions to checkout the repository.
+In non-`push` events, such as `pull_request`, make sure to specify the `ref` to checkout:
 
 ```yaml
-name: php-cs-fixer
-
-on: push
-
-jobs:
-  php-cs-fixer:
-    runs-on: ubuntu-latest
-
-    steps:
-    - uses: actions/checkout@v2
-      with:
-        token: ${{ secrets.PAT_TOKEN }}
-
-    - name: Run php-cs-fixer
-      uses: docker://oskarstark/php-cs-fixer-ga
-
-    - uses: stefanzweifel/git-auto-commit-action@v4.1.6
-      with:
-        commit_message: Apply php-cs-fixer changes
+- uses: actions/checkout@v2
+  with:
+    ref: ${{ github.head_ref }}
 ```
 
-## Known Issues
+You have to do this do avoid that the `checkout`-Action clones your repository in a detached state.
 
-- GitHub currently prohibits Actions like this to push changes from a fork to the upstream repository. See [issue #25](https://github.com/stefanzweifel/git-auto-commit-action/issues/25) for more information.
+### 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).
+
+> 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 step.
+
+```yaml
+- uses: actions/checkout@v2
+  with:
+    token: ${{ secrets.PAT }}
+```
+
+### Unable to commit into PRs from forks
+
+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.
+
+### 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))
+
+## Troubleshooting
+
+### Action does not push commit to repository
+
+Make sure to [checkout the correct branch](#checkout-the-correct-branch).
+
+### Action does not push commit to repository: Authentication Issue
+
+If your Workflow can't push the commit to the repository because of authentication issues,
+please update your Workflow configuration and usage of [`actions/checkout`](https://github.com/actions/checkout#usage).
+
+Updating the `token` value with a Personal Access Token should fix your issues.
+
+### Push to protected branches
+
+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 this.
+
+```yaml
+    - uses: stefanzweifel/git-auto-commit-action@v4
+      with:
+        commit_message: Apply php-cs-fixer changes
+        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).
 
 ## 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://help.github.com/en/actions/building-actions/about-actions#versioning-your-action).)
+
 ## License
 
 This project is licensed under the MIT License - see the [LICENSE](https://github.com/stefanzweifel/git-auto-commit-action/blob/master/LICENSE) file for details.

action.yml

@@ -10,7 +10,7 @@ inputs:
   branch:
     description: Git branch name, where changes should be pushed too. Required if Action is used on the `pull_request` event
     required: false
-    default: ''
+    default: ${{ github.head_ref }}
   commit_options:
     description: Commit options (eg. --no-verify)
     required: false
@@ -39,6 +39,14 @@ inputs:
     description: Message used to create a new git tag with the commit. Keep this empty, if no tag should be created.
     required: false
     default: ''
+  push_options:
+    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
 
 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";
 
@@ -33,7 +33,7 @@ _switch_to_repository() {
 }
 
 _git_is_dirty() {
-    [ -n "$(git status -s)" ]
+    [ -n "$(git status -s -- $INPUT_FILE_PATTERN)" ]
 }
 
 _switch_to_branch() {
@@ -73,21 +73,27 @@ _tag_commit() {
 }
 
 _push_to_github() {
+
+    echo "INPUT_PUSH_OPTIONS: ${INPUT_PUSH_OPTIONS}";
+    echo "::debug::Apply push options ${INPUT_PUSH_OPTIONS}";
+
+    INPUT_PUSH_OPTIONS_ARRAY=( $INPUT_PUSH_OPTIONS );
+
     if [ -z "$INPUT_BRANCH" ]
     then
         # Only add `--tags` option, if `$INPUT_TAGGING_MESSAGE` is set
         if [ -n "$INPUT_TAGGING_MESSAGE" ]
         then
             echo "::debug::git push origin --tags";
-            git push origin --tags;
+            git push origin --tags ${INPUT_PUSH_OPTIONS:+"${INPUT_PUSH_OPTIONS_ARRAY[@]}"};
         else
             echo "::debug::git push origin";
-            git push origin;
+            git push origin ${INPUT_PUSH_OPTIONS:+"${INPUT_PUSH_OPTIONS_ARRAY[@]}"};
         fi
 
     else
         echo "::debug::Push commit to remote branch $INPUT_BRANCH";
-        git push --set-upstream origin "HEAD:$INPUT_BRANCH" --tags;
+        git push --set-upstream origin "HEAD:$INPUT_BRANCH" --tags ${INPUT_PUSH_OPTIONS:+"${INPUT_PUSH_OPTIONS_ARRAY[@]}"};
     fi
 }