From c40819ab3b7619623b7d0d760f3296f014f245b8 Mon Sep 17 00:00:00 2001 From: Stefan Zweifel Date: Sun, 12 Oct 2025 14:59:32 +0200 Subject: [PATCH] Update README --- README.md | 5 ++--- action.yml | 4 ++-- 2 files changed, 4 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index cb1ca49..6c84bbc 100644 --- a/README.md +++ b/README.md @@ -93,8 +93,7 @@ The following is an extended example with all available options. # Optional. Message to annotate the created tag with. # 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. - tagging_message: 'MyProduct v1.0.0' - + tagging_message: 'Codename "Sunshine"' # Optional. Option used by `git-status` to determine if the repository is # dirty. See https://git-scm.com/docs/git-status#_options @@ -125,7 +124,7 @@ The following is an extended example with all available options. create_branch: true # 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`. + # Skips dirty check and changed files. Must be used in combination with `tag` and `tagging_message`. create_git_tag_only: false ``` diff --git a/action.yml b/action.yml index 74c8192..767ee3d 100644 --- a/action.yml +++ b/action.yml @@ -45,11 +45,11 @@ inputs: required: false default: ${{ github.actor }} <${{ github.actor_id }}+${{ github.actor }}@users.noreply.github.com> tag: - description: New git tag with the commit. Keep this empty, if no tag should be created. + description: Tag name used for creating a new git tag with the commit. Keep this empty, if no tag should be created. required: false default: '' tagging_message: - description: Message used to create a new git tag with the commit. + description: Tagging message used for creating a new git tag with the commit. Keep this empty, if no tag should be created. required: false default: '' push_options: