git-auto-commit-action/action.yml

90 lines
3.0 KiB
YAML
Raw Normal View History

2019-08-20 18:43:07 +00:00
name: Git Auto Commit
2019-10-26 14:33:59 +00:00
description: 'Automatically commits files which have been changed during the workflow run and push changes back to remote repository.'
2019-08-20 18:43:07 +00:00
2023-01-25 18:57:43 +00:00
author: Stefan Zweifel <stefan@stefanzweifel.dev>
2019-08-20 19:05:17 +00:00
2019-08-20 18:43:07 +00:00
inputs:
commit_message:
2019-09-20 08:46:35 +00:00
description: Commit message
2020-10-11 18:14:15 +00:00
required: false
2020-10-11 12:45:47 +00:00
default: Apply automatic changes
2020-02-05 19:24:25 +00:00
branch:
2020-02-06 19:49:03 +00:00
description: Git branch name, where changes should be pushed too. Required if Action is used on the `pull_request` event
2020-02-05 20:12:20 +00:00
required: false
default: ${{ github.head_ref }}
commit_options:
2019-12-18 10:58:17 +00:00
description: Commit options (eg. --no-verify)
required: false
2020-04-22 18:39:08 +00:00
default: ''
2021-05-03 15:26:56 +00:00
add_options:
description: Add options (eg. -u)
required: false
default: ''
status_options:
description: Status options (eg. --untracked-files=no)
required: false
default: ''
2019-10-25 18:51:12 +00:00
file_pattern:
description: File pattern used for `git add`. For example `src/*.js`
required: false
2019-11-01 09:15:22 +00:00
default: '.'
repository:
2020-02-05 19:24:25 +00:00
description: Local file path to the git repository. Defaults to the current directory (`.`)
required: false
default: '.'
commit_user_name:
description: Name used for the commit user
required: false
default: github-actions[bot]
commit_user_email:
description: Email address used for the commit user
required: false
default: 41898282+github-actions[bot]@users.noreply.github.com
2020-02-04 20:02:40 +00:00
commit_author:
2020-02-05 19:24:25 +00:00
description: Value used for the commit author. Defaults to the username of whoever triggered this workflow run.
2020-02-04 20:02:40 +00:00
required: false
default: ${{ github.actor }} <${{ github.actor }}@users.noreply.github.com>
2020-03-05 19:31:06 +00:00
tagging_message:
2020-03-05 19:48:00 +00:00
description: Message used to create a new git tag with the commit. Keep this empty, if no tag should be created.
2020-03-05 19:31:06 +00:00
required: false
default: ''
2020-05-16 09:42:24 +00:00
push_options:
description: Push options (eg. --force)
required: false
default: ''
2020-06-25 18:18:20 +00:00
skip_dirty_check:
description: Skip the check if the git repository is dirty and always try to create a commit.
required: false
default: false
skip_fetch:
description: Skip the call to git-fetch.
required: false
default: false
2022-01-10 00:10:05 +00:00
skip_checkout:
description: Skip the call to git-checkout.
required: false
default: false
2021-04-10 15:10:27 +00:00
disable_globbing:
description: Stop the shell from expanding filenames (https://www.gnu.org/software/bash/manual/html_node/Filename-Expansion.html)
default: false
create_branch:
description: Create new branch with the name of `branch`-input in local and remote repository, if it doesn't exist yet.
default: false
internal_git_binary:
description: Internal use only! Path to git binary used to check if git is available. (Don't change this!)
default: git
2019-09-20 08:30:36 +00:00
2020-03-04 18:56:33 +00:00
outputs:
changes_detected:
description: Value is "true", if the repository was dirty and file changes have been detected. Value is "false", if no changes have been detected.
2021-09-10 10:39:35 +00:00
commit_hash:
description: Full hash of the created commit. Only present if the "changes_detected" output is "true".
2020-03-04 18:56:33 +00:00
2019-08-20 18:43:07 +00:00
runs:
using: 'node16'
2020-02-11 20:04:18 +00:00
main: 'index.js'
2019-08-20 18:43:07 +00:00
branding:
icon: 'git-commit'
color: orange