Skip to content

Commit 9fd88c9

Browse files
Update README
1 parent 8655eda commit 9fd88c9

File tree

1 file changed

+2
-3
lines changed

1 file changed

+2
-3
lines changed

README.md

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

9191
# Optional. Message to annotate the created tag with.
9292
# 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.
93-
tagging_message: 'MyProduct v1.0.0'
94-
93+
tagging_message: 'Codename "Sunshine"'
9594

9695
# Optional. Option used by `git-status` to determine if the repository is
9796
# dirty. See https://git-scm.com/docs/git-status#_options
@@ -122,7 +121,7 @@ The following is an extended example with all available options.
122121
create_branch: true
123122

124123
# Optional. Creates a new tag and pushes it to remote without creating a commit.
125-
# Skips dirty check and changed files. Must be used with `tagging_message`.
124+
# Skips dirty check and changed files. Must be used in combination with `tag` and `tagging_message`.
126125
create_git_tag_only: false
127126
```
128127

0 commit comments

Comments
 (0)