Skip to content

Commit adb37b5

Browse files
committed
Update README
1 parent 8480c68 commit adb37b5

File tree

2 files changed

+4
-3
lines changed

2 files changed

+4
-3
lines changed

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -119,8 +119,8 @@ The following is an extended example with all available options.
119119
# Optional. Create given branch name in local and remote repository.
120120
create_branch: true
121121

122-
# Perform a clean git tag and push, without commiting anything
123-
# Default to false
122+
# Optional. Creates a new tag and pushes it to remote without creating a commit.
123+
# Skips dirty check and changed files. Must be used with `tagging_message`.
124124
create_git_tag_only: false
125125
```
126126
@@ -173,6 +173,7 @@ You can use these outputs to trigger other Actions in your Workflow run based on
173173

174174
- `changes_detected`: Returns either "true" or "false" if the repository was dirty and files have changed.
175175
- `commit_hash`: Returns the full hash of the commit if one was created.
176+
- `create_git_tag_only`: Returns either "true" or "false" if a tag was created, when `create_git_tag_only` was used.
176177

177178
**⚠️ When using outputs, the step needs to be given an id. See example below.**
178179

action.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ outputs:
8484
commit_hash:
8585
description: Full hash of the created commit. Only present if the "changes_detected" output is "true".
8686
create_git_tag_only:
87-
description:
87+
description: Value is "true", if a git tag was created using the `create_git_tag_only`-input.
8888

8989
runs:
9090
using: 'node20'

0 commit comments

Comments
 (0)