suyiiyii/git-auto-commit-action
1
0
Fork 0
mirror of https://github.com/stefanzweifel/git-auto-commit-action.git synced 2024-12-06 02:09:04 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update Docs

Browse Source
This commit is contained in:
Stefan Zweifel 2020-02-05 20:24:25 +01:00
parent 0a5fd7e510
commit 5432544bdb
2 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -28,10 +28,10 @@ Add the following step at the end of your job.
# Optional glob pattern of files which should be added to the commit # Optional glob pattern of files which should be added to the commit
file_pattern: src/\*.js file_pattern: src/\*.js
# Optional repository path # Optional local file path to the repository
repository: . repository: .
# Optional commit user settings # Optional commit user and author settings
commit_user_name: My GitHub Actions Bot commit_user_name: My GitHub Actions Bot
commit_user_email: my-github-actions-bot@example.org commit_user_email: my-github-actions-bot@example.org
commit_author: Author <actions@gitub.com> commit_author: Author <actions@gitub.com>

12
action.yml
View File

@ -7,18 +7,18 @@ inputs:
commit_message: commit_message:
description: Commit message description: Commit message
required: true required: true
branch:
description: Git branch name, where changes should be pushed too.
required: true
commit_options: commit_options:
description: Commit options (eg. --no-verify) description: Commit options (eg. --no-verify)
required: false required: false
branch:
description: Branch name where changes should be pushed too
required: true
file_pattern: file_pattern:
description: File pattern used for "git add" description: File pattern used for `git add`. For example `src/\*.js`
required: false required: false
default: '.' default: '.'
repository: repository:
description: Path to git repository description: Local file path to the git repository. Defaults to the current directory (`.`)
required: false required: false
default: '.' default: '.'
commit_user_name: commit_user_name:
@ -30,7 +30,7 @@ inputs:
required: false required: false
default: actions@github.com default: actions@github.com
commit_author: commit_author:
description: Value used for the commit author description: Value used for the commit author. Defaults to the username of whoever triggered this workflow run.
required: false required: false
default: ${{ github.actor }} <${{ github.actor }}@users.noreply.github.com> default: ${{ github.actor }} <${{ github.actor }}@users.noreply.github.com>