actions/git-auto-commit-action
1
0
Fork 0
mirror of https://github.com/stefanzweifel/git-auto-commit-action.git synced 2026-01-11 12:08:25 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update README

Browse Source
This commit is contained in:
Stefan Zweifel
2025-10-12 14:59:32 +02:00
parent d7ee275235
commit c40819ab3b
2 changed files with 4 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
README.md
View File

@@ -93,8 +93,7 @@ The following is an extended example with all available options.
# Optional. Message to annotate the created tag with. # Optional. Message to annotate the created tag with.
# If only one of `tag` or `tagging_message` is provided, the value of the provided field will be used for both tag name and message. # If only one of `tag` or `tagging_message` is provided, the value of the provided field will be used for both tag name and message.
tagging_message: 'MyProduct v1.0.0' tagging_message: 'Codename "Sunshine"'
# Optional. Option used by `git-status` to determine if the repository is # Optional. Option used by `git-status` to determine if the repository is
# dirty. See https://git-scm.com/docs/git-status#_options # dirty. See https://git-scm.com/docs/git-status#_options
@@ -125,7 +124,7 @@ The following is an extended example with all available options.
create_branch: true create_branch: true
# Optional. Creates a new tag and pushes it to remote without creating a commit. # Optional. Creates a new tag and pushes it to remote without creating a commit.
# Skips dirty check and changed files. Must be used with `tagging_message`. # Skips dirty check and changed files. Must be used in combination with `tag` and `tagging_message`.
create_git_tag_only: false create_git_tag_only: false
``` ```

4
action.yml
View File

@@ -45,11 +45,11 @@ inputs:
required: false required: false
default: ${{ github.actor }} <${{ github.actor_id }}+${{ github.actor }}@users.noreply.github.com> default: ${{ github.actor }} <${{ github.actor_id }}+${{ github.actor }}@users.noreply.github.com>
tag: tag:
description: New git tag with the commit. Keep this empty, if no tag should be created. description: Tag name used for creating a new git tag with the commit. Keep this empty, if no tag should be created.
required: false required: false
default: '' default: ''
tagging_message: tagging_message:
description: Message used to create a new git tag with the commit. description: Tagging message used for creating a new git tag with the commit. Keep this empty, if no tag should be created.
required: false required: false
default: '' default: ''
push_options: push_options: