Update README

This commit is contained in:
Stefan Zweifel 2025-04-19 10:32:21 +02:00
parent 8480c68cbb
commit adb37b5a29
No known key found for this signature in database
2 changed files with 4 additions and 3 deletions

View File

@ -119,8 +119,8 @@ The following is an extended example with all available options.
# Optional. Create given branch name in local and remote repository. # Optional. Create given branch name in local and remote repository.
create_branch: true create_branch: true
# Perform a clean git tag and push, without commiting anything # Optional. Creates a new tag and pushes it to remote without creating a commit.
# Default to false # Skips dirty check and changed files. Must be used with `tagging_message`.
create_git_tag_only: false 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. - `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. - `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.** **⚠️ When using outputs, the step needs to be given an id. See example below.**

View File

@ -84,7 +84,7 @@ outputs:
commit_hash: commit_hash:
description: Full hash of the created commit. Only present if the "changes_detected" output is "true". description: Full hash of the created commit. Only present if the "changes_detected" output is "true".
create_git_tag_only: create_git_tag_only:
description: description: Value is "true", if a git tag was created using the `create_git_tag_only`-input.
runs: runs:
using: 'node20' using: 'node20'