diff --git a/README.md b/README.md index 958ea0f..d49972f 100644 --- a/README.md +++ b/README.md @@ -39,7 +39,7 @@ Add the following step at the end of your job. commit_user_email: my-github-actions-bot@example.org commit_author: Author - # Optional. If value is set, the commit will be tagged with the given value + # Optional tag message. Will create and push a new tag to the remote repository tagging_message: 'v1.0.0' ``` diff --git a/action.yml b/action.yml index fd60cb1..2ca3947 100644 --- a/action.yml +++ b/action.yml @@ -35,7 +35,7 @@ inputs: required: false default: ${{ github.actor }} <${{ github.actor }}@users.noreply.github.com> tagging_message: - description: Value used for a git tag. Keep it empty to not tag the commit. + description: Message used to create a new git tag with the commit. Keep this empty, if no tag should be created. required: false default: ''