Skip to content

Commit b9c5365

Browse files
committed
Add new *_options to README
1 parent 68f0d95 commit b9c5365

1 file changed

Lines changed: 20 additions & 11 deletions

File tree

README.md

Lines changed: 20 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -29,16 +29,16 @@ This is a more extended example with all possible options.
2929
```yaml
3030
- uses: stefanzweifel/git-auto-commit-action@v4
3131
with:
32-
# Optional but recommended
32+
# Optional, but recommended
3333
# Defaults to "Apply automatic changes"
34-
commit_message: Apply automatic changes
34+
commit_message: Automated Change
3535

36-
# Optional branch name where commit should be pushed to
37-
# Defaults to the current branch
36+
# Optional branch name where commit should be pushed to.
37+
# Defaults to the current branch.
3838
branch: feature-123
3939

40-
# Optional options appended to `git-commit`
41-
# See https://git-scm.com/docs/git-commit for a list of available options
40+
# Optional. Used by `git-commit`.
41+
# See https://git-scm.com/docs/git-commit#_options
4242
commit_options: '--no-verify --signoff'
4343

4444
# Optional glob pattern of files which should be added to the commit
@@ -61,17 +61,26 @@ This is a more extended example with all possible options.
6161
# Action will create and push a new tag to the remote repository and the defined branch
6262
tagging_message: 'v1.0.0'
6363

64-
# Optional options appended to `git-push`
65-
# See git-push documentation for details: https://git-scm.com/docs/git-push#_options
64+
# Optional. Used by `git-status`
65+
# See https://git-scm.com/docs/git-status#_options
66+
status_options: '--untracked-files=no'
67+
68+
# Optional. Used by `git-add`
69+
# See https://git-scm.com/docs/git-add#_options
70+
add_options: '-u'
71+
72+
# Optional. Used by `git-push`
73+
# See https://git-scm.com/docs/git-push#_options
6674
push_options: '--force'
6775

68-
# Optional: Disable dirty check and always try to create a commit and push
76+
# Optional. Disable dirty check and always try to create a commit and push
6977
skip_dirty_check: true
7078

71-
# Optional: Skip internal call to `git fetch`
79+
# Optional. Skip internal call to `git fetch`
7280
skip_fetch: true
7381

74-
# Optional: Prevents the shell from expanding filenames. Details: https://www.gnu.org/software/bash/manual/html_node/Filename-Expansion.html
82+
# Optional. Prevents the shell from expanding filenames.
83+
# Details: https://www.gnu.org/software/bash/manual/html_node/Filename-Expansion.html
7584
disable_globbing: true
7685
```
7786

0 commit comments

Comments
 (0)