Release v4.5.0

Creating orphan branch

.github/FUNDING.yml

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

.github/workflows/versioning.yml

@@ -12,4 +12,4 @@ jobs:
         env:
           GITHUB_TOKEN: "${{secrets.GITHUB_TOKEN}}"
         with:
-          - publish_latest_tag: true
+          publish_latest_tag: true

CHANGELOG.md

@@ -4,15 +4,25 @@ 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.4.0...HEAD)
+## [Unreleased](https://github.com/stefanzweifel/git-auto-commit-action/compare/v4.5.0...HEAD)
 
 > TBD
 
 
+## [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)
 
 

README.md

@@ -22,10 +22,14 @@ Add the following step at the end of your job, after other steps that might add
     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
+    # 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
     repository: .
@@ -40,6 +44,7 @@ Add the following step at the end of your job, after other steps that might add
     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
@@ -79,6 +84,16 @@ 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.
+
 ## Limitations & Gotchas
 
 ### Checkout the correct branch
@@ -102,31 +117,82 @@ This is due to [limititations set by GitHub](https://help.github.com/en/actions/
 > 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.
+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.)
 
-## Outputs
+If you want that a Workflow using this Action runs on Pull Requests opened by forks, 2 things have to be changed:
 
-You can use these outputs to trigger other Actions in your Workflow run based on the result of `git-auto-commit-action`.
+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: [pull_request, pull_request_target]
+
+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/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).
@@ -138,11 +204,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
@@ -151,6 +217,18 @@ 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).

entrypoint.sh

@@ -1,6 +1,7 @@
 #!/bin/bash
 
 set -eu
+set -x
 
 _main() {
     _switch_to_repository
@@ -33,14 +34,19 @@ _switch_to_repository() {
 }
 
 _git_is_dirty() {
-    [ -n "$(git status -s)" ]
+    [ -n "$(git status -s -- $INPUT_FILE_PATTERN)" ]
 }
 
 _switch_to_branch() {
     echo "INPUT_BRANCH value: $INPUT_BRANCH";
 
-    # Switch to branch from current Workflow run
-    git checkout $INPUT_BRANCH;
+    if git show-ref --verify --quiet refs/heads/$INPUT_BRANCH; then
+        # Switch to branch from current Workflow run
+        git checkout $INPUT_BRANCH;
+    else 
+        git checkout --orphan $INPUT_BRANCH
+        git rm -rf .
+    fi
 }
 
 _add_files() {