Skip to content

Commit c40819a

Browse files
committed
Update README
1 parent d7ee275 commit c40819a

File tree

2 files changed

+4
-5
lines changed

2 files changed

+4
-5
lines changed

README.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -93,8 +93,7 @@ The following is an extended example with all available options.
9393

9494
# Optional. Message to annotate the created tag with.
9595
# 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.
96-
tagging_message: 'MyProduct v1.0.0'
97-
96+
tagging_message: 'Codename "Sunshine"'
9897

9998
# Optional. Option used by `git-status` to determine if the repository is
10099
# dirty. See https://git-scm.com/docs/git-status#_options
@@ -125,7 +124,7 @@ The following is an extended example with all available options.
125124
create_branch: true
126125

127126
# Optional. Creates a new tag and pushes it to remote without creating a commit.
128-
# Skips dirty check and changed files. Must be used with `tagging_message`.
127+
# Skips dirty check and changed files. Must be used in combination with `tag` and `tagging_message`.
129128
create_git_tag_only: false
130129
```
131130

action.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,11 +45,11 @@ inputs:
4545
required: false
4646
default: ${{ github.actor }} <${{ github.actor_id }}+${{ github.actor }}@users.noreply.github.com>
4747
tag:
48-
description: New git tag with the commit. Keep this empty, if no tag should be created.
48+
description: Tag name used for creating a new git tag with the commit. Keep this empty, if no tag should be created.
4949
required: false
5050
default: ''
5151
tagging_message:
52-
description: Message used to create a new git tag with the commit.
52+
description: Tagging message used for creating a new git tag with the commit. Keep this empty, if no tag should be created.
5353
required: false
5454
default: ''
5555
push_options:

0 commit comments

Comments
 (0)