From 864c975b874d5cff2680de061168816ce72fd236 Mon Sep 17 00:00:00 2001 From: Stefan Zweifel Date: Thu, 6 Feb 2020 20:49:03 +0100 Subject: [PATCH] Update README --- README.md | 27 +++++++++++++++++++++++++-- action.yml | 2 +- 2 files changed, 26 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index f32de1f..04332b6 100644 --- a/README.md +++ b/README.md @@ -17,9 +17,12 @@ This Action has been inspired and adapted from the [auto-commit](https://github. Add the following step at the end of your job. ```yaml -- uses: stefanzweifel/git-auto-commit-action@v2.5.0 +- uses: stefanzweifel/git-auto-commit-action@v3.0.0 with: 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 git params @@ -65,12 +68,32 @@ jobs: - name: Run php-cs-fixer uses: docker://oskarstark/php-cs-fixer-ga - - uses: stefanzweifel/git-auto-commit-action@v2.5.0 + - uses: stefanzweifel/git-auto-commit-action@v3.0.0 with: commit_message: Apply php-cs-fixer changes branch: ${{ github.head_ref }} ``` +```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@v3.0.0 + with: + 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. diff --git a/action.yml b/action.yml index d239de0..4988a84 100644 --- a/action.yml +++ b/action.yml @@ -8,7 +8,7 @@ inputs: description: Commit message required: true branch: - description: Git branch name, where changes should be pushed too. + description: Git branch name, where changes should be pushed too. Required if Action is used on the `pull_request` event required: false default: '' commit_options: