From 7cec9acee664884964a44d29ae0a040333c45e12 Mon Sep 17 00:00:00 2001 From: Stefan Zweifel Date: Wed, 28 Oct 2020 20:26:25 +0100 Subject: [PATCH] Improve Example --- README.md | 21 ++++++++++++++++----- 1 file changed, 16 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index a7c4f42..b215335 100644 --- a/README.md +++ b/README.md @@ -19,13 +19,22 @@ This Action has been inspired and adapted from the [auto-commit](https://github. 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: - # Optional but recommended, defaults to "Apply automatic changes" + # 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` @@ -33,18 +42,20 @@ Add the following step at the end of your job, after other steps that might add commit_options: '--no-verify --signoff' # Optional glob pattern of files which should be added to the commit + # 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 + 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 # 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