From adb37b5a29cc6a129145d9d032185cb98f85158c Mon Sep 17 00:00:00 2001 From: Stefan Zweifel Date: Sat, 19 Apr 2025 10:32:21 +0200 Subject: [PATCH] Update README --- README.md | 5 +++-- action.yml | 2 +- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 60071bb..4e9b319 100644 --- a/README.md +++ b/README.md @@ -119,8 +119,8 @@ The following is an extended example with all available options. # Optional. Create given branch name in local and remote repository. create_branch: true - # Perform a clean git tag and push, without commiting anything - # Default to false + # 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`. create_git_tag_only: false ``` @@ -173,6 +173,7 @@ You can use these outputs to trigger other Actions in your Workflow run based on - `changes_detected`: Returns either "true" or "false" if the repository was dirty and files have changed. - `commit_hash`: Returns the full hash of the commit if one was created. +- `create_git_tag_only`: Returns either "true" or "false" if a tag was created, when `create_git_tag_only` was used. **⚠️ When using outputs, the step needs to be given an id. See example below.** diff --git a/action.yml b/action.yml index caf8237..c57a508 100644 --- a/action.yml +++ b/action.yml @@ -84,7 +84,7 @@ outputs: commit_hash: description: Full hash of the created commit. Only present if the "changes_detected" output is "true". create_git_tag_only: - description: + description: Value is "true", if a git tag was created using the `create_git_tag_only`-input. runs: using: 'node20'