suyiiyii/git-auto-commit-action
1
0
Fork 0
mirror of https://github.com/stefanzweifel/git-auto-commit-action.git synced 2026-06-16 16:38:51 +00:00
Code Issues Packages Projects Releases Wiki Activity

Rename input 'tag' to 'tag_name' throughout codebase

Browse Source 
Replaces all occurrences of the 'tag' input with 'tag_name' in documentation, action definition, entrypoint script, and tests for consistency and clarity. This change ensures the input name is more descriptive and avoids ambiguity.
This commit is contained in:
Stefan Zweifel 2025-10-12 15:30:56 +02:00
parent f57c3b9583
commit a7a557466e
No known key found for this signature in database
4 changed files with 30 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -88,11 +88,11 @@ The following is an extended example with all available options.
# Optional. Tag name to be created in the local repository and # Optional. Tag name to be created in the local repository and
# pushed to the remote repository on the defined branch. # pushed to the remote repository on the defined branch.
# 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. # If only one of `tag_name` or `tagging_message` is provided, the value of the provided field will be used for both tag name and message.
tag: 'v1.0.0' tag_name: 'v1.0.0'
# Optional. Message to annotate the created tag with. # 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. # If only one of `tag_name` or `tagging_message` is provided, the value of the provided field will be used for both tag name and message.
tagging_message: 'Codename "Sunshine"' tagging_message: 'Codename "Sunshine"'
# Optional. Option used by `git-status` to determine if the repository is # Optional. Option used by `git-status` to determine if the repository is

2
action.yml
View File

@ -44,7 +44,7 @@ inputs:
description: Value used for the commit author. Defaults to the username of whoever triggered this workflow run. description: Value used for the commit author. Defaults to the username of whoever triggered this workflow run.
required: false required: false
default: ${{ github.actor }} <${{ github.actor_id }}+${{ github.actor }}@users.noreply.github.com> default: ${{ github.actor }} <${{ github.actor_id }}+${{ github.actor }}@users.noreply.github.com>
tag: tag_name:
description: Tag name used for creating a 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 required: false
default: '' default: ''

12
entrypoint.sh
View File

@ -176,12 +176,12 @@ _local_commit() {
} }
_tag_commit() { _tag_commit() {
echo "INPUT_TAG: ${INPUT_TAG}" echo "INPUT_TAG_NAME: ${INPUT_TAG_NAME}"
echo "INPUT_TAGGING_MESSAGE: ${INPUT_TAGGING_MESSAGE}" echo "INPUT_TAGGING_MESSAGE: ${INPUT_TAGGING_MESSAGE}"
if [ -n "$INPUT_TAG" ] || [ -n "$INPUT_TAGGING_MESSAGE" ]; then if [ -n "$INPUT_TAG_NAME" ] || [ -n "$INPUT_TAGGING_MESSAGE" ]; then
INTERNAL_TAG=${INPUT_TAG:-$INPUT_TAGGING_MESSAGE} INTERNAL_TAG=${INPUT_TAG_NAME:-$INPUT_TAGGING_MESSAGE}
INTERNAL_TAGGING_MESSAGE=${INPUT_TAGGING_MESSAGE:-$INPUT_TAG} INTERNAL_TAGGING_MESSAGE=${INPUT_TAGGING_MESSAGE:-$INPUT_TAG_NAME}
_log "debug" "Create tag $INTERNAL_TAG: $INTERNAL_TAGGING_MESSAGE" _log "debug" "Create tag $INTERNAL_TAG: $INTERNAL_TAGGING_MESSAGE"
git -c user.name="$INPUT_COMMIT_USER_NAME" -c user.email="$INPUT_COMMIT_USER_EMAIL" tag -a "$INTERNAL_TAG" -m "$INTERNAL_TAGGING_MESSAGE" git -c user.name="$INPUT_COMMIT_USER_NAME" -c user.email="$INPUT_COMMIT_USER_EMAIL" tag -a "$INTERNAL_TAG" -m "$INTERNAL_TAGGING_MESSAGE"
@ -202,8 +202,8 @@ _push_to_github() {
if [ -z "$INPUT_BRANCH" ] if [ -z "$INPUT_BRANCH" ]
then then
# Only add `--tags` option, if `$INPUT_TAG` or `$INPUT_TAGGING_MESSAGE` is set # Only add `--tags` option, if `$INPUT_TAG_NAME` or `$INPUT_TAGGING_MESSAGE` is set
if [ -n "$INPUT_TAG" ] || [ -n "$INPUT_TAGGING_MESSAGE" ] if [ -n "$INPUT_TAG_NAME" ] || [ -n "$INPUT_TAGGING_MESSAGE" ]
then then
_log "debug" "git push origin --tags"; _log "debug" "git push origin --tags";
git push origin --follow-tags --atomic ${INPUT_PUSH_OPTIONS:+"${INPUT_PUSH_OPTIONS_ARRAY[@]}"}; git push origin --follow-tags --atomic ${INPUT_PUSH_OPTIONS:+"${INPUT_PUSH_OPTIONS_ARRAY[@]}"};

40
tests/git-auto-commit.bats
View File

@ -32,7 +32,7 @@ setup() {
export INPUT_COMMIT_USER_NAME="Test Suite" export INPUT_COMMIT_USER_NAME="Test Suite"
export INPUT_COMMIT_USER_EMAIL="test@github.com" export INPUT_COMMIT_USER_EMAIL="test@github.com"
export INPUT_COMMIT_AUTHOR="Test Suite <test@users.noreply.github.com>" export INPUT_COMMIT_AUTHOR="Test Suite <test@users.noreply.github.com>"
export INPUT_TAG="" export INPUT_TAG_NAME=""
export INPUT_TAGGING_MESSAGE="" export INPUT_TAGGING_MESSAGE=""
export INPUT_PUSH_OPTIONS="" export INPUT_PUSH_OPTIONS=""
export INPUT_SKIP_DIRTY_CHECK=false export INPUT_SKIP_DIRTY_CHECK=false
@ -122,7 +122,7 @@ cat_github_output() {
assert_line "INPUT_FILE_PATTERN: ." assert_line "INPUT_FILE_PATTERN: ."
assert_line "INPUT_COMMIT_OPTIONS: " assert_line "INPUT_COMMIT_OPTIONS: "
assert_line "::debug::Apply commit options " assert_line "::debug::Apply commit options "
assert_line "INPUT_TAG: " assert_line "INPUT_TAG_NAME: "
assert_line "INPUT_TAGGING_MESSAGE: " assert_line "INPUT_TAGGING_MESSAGE: "
assert_line "Neither tag nor tag message is set. No tag will be added." assert_line "Neither tag nor tag message is set. No tag will be added."
assert_line "INPUT_PUSH_OPTIONS: " assert_line "INPUT_PUSH_OPTIONS: "
@ -146,7 +146,7 @@ cat_github_output() {
assert_line "INPUT_FILE_PATTERN: ." assert_line "INPUT_FILE_PATTERN: ."
assert_line "INPUT_COMMIT_OPTIONS: " assert_line "INPUT_COMMIT_OPTIONS: "
assert_line "::debug::Apply commit options " assert_line "::debug::Apply commit options "
assert_line "INPUT_TAG: " assert_line "INPUT_TAG_NAME: "
assert_line "INPUT_TAGGING_MESSAGE: " assert_line "INPUT_TAGGING_MESSAGE: "
assert_line "Neither tag nor tag message is set. No tag will be added." assert_line "Neither tag nor tag message is set. No tag will be added."
assert_line "INPUT_PUSH_OPTIONS: " assert_line "INPUT_PUSH_OPTIONS: "
@ -294,7 +294,7 @@ cat_github_output() {
} }
@test "It creates a tag with the commit" { @test "It creates a tag with the commit" {
INPUT_TAG="v1.0.0" INPUT_TAG_NAME="v1.0.0"
INPUT_TAGGING_MESSAGE="MyProduct v1.0.0" INPUT_TAGGING_MESSAGE="MyProduct v1.0.0"
touch "${FAKE_LOCAL_REPOSITORY}"/new-file-{1,2,3}.txt touch "${FAKE_LOCAL_REPOSITORY}"/new-file-{1,2,3}.txt
@ -303,7 +303,7 @@ cat_github_output() {
assert_success assert_success
assert_line "INPUT_TAG: v1.0.0" assert_line "INPUT_TAG_NAME: v1.0.0"
assert_line "INPUT_TAGGING_MESSAGE: MyProduct v1.0.0" assert_line "INPUT_TAGGING_MESSAGE: MyProduct v1.0.0"
assert_line "::debug::Create tag v1.0.0: MyProduct v1.0.0" assert_line "::debug::Create tag v1.0.0: MyProduct v1.0.0"
@ -394,7 +394,7 @@ cat_github_output() {
@test "It uses existing branch when INPUT_BRANCH is empty and INPUT_TAG is set" { @test "It uses existing branch when INPUT_BRANCH is empty and INPUT_TAG is set" {
INPUT_BRANCH="" INPUT_BRANCH=""
INPUT_TAG="v2.0.0" INPUT_TAG_NAME="v2.0.0"
INPUT_TAGGING_MESSAGE="MyProduct v2.0.0" INPUT_TAGGING_MESSAGE="MyProduct v2.0.0"
@ -404,7 +404,7 @@ cat_github_output() {
assert_success assert_success
assert_line "INPUT_TAG: v2.0.0" assert_line "INPUT_TAG_NAME: v2.0.0"
assert_line "::debug::Create tag v2.0.0: MyProduct v2.0.0" assert_line "::debug::Create tag v2.0.0: MyProduct v2.0.0"
assert_line "::debug::git push origin --tags" assert_line "::debug::git push origin --tags"
@ -445,7 +445,7 @@ cat_github_output() {
@test "It pushes generated commit and tag to remote and actually updates the commit shas" { @test "It pushes generated commit and tag to remote and actually updates the commit shas" {
INPUT_BRANCH="" INPUT_BRANCH=""
INPUT_TAG="v2.0.0" INPUT_TAG_NAME="v2.0.0"
INPUT_TAGGING_MESSAGE="MyProduct v2.0.0" INPUT_TAGGING_MESSAGE="MyProduct v2.0.0"
@ -455,7 +455,7 @@ cat_github_output() {
assert_success assert_success
assert_line "INPUT_TAG: v2.0.0" assert_line "INPUT_TAG_NAME: v2.0.0"
assert_line "::debug::Create tag v2.0.0: MyProduct v2.0.0" assert_line "::debug::Create tag v2.0.0: MyProduct v2.0.0"
assert_line "::debug::git push origin --tags" assert_line "::debug::git push origin --tags"
@ -480,7 +480,7 @@ cat_github_output() {
git checkout ${FAKE_DEFAULT_BRANCH} git checkout ${FAKE_DEFAULT_BRANCH}
INPUT_BRANCH="a-new-branch" INPUT_BRANCH="a-new-branch"
INPUT_TAG="v2.0.0" INPUT_TAG_NAME="v2.0.0"
INPUT_TAGGING_MESSAGE="MyProduct v2.0.0" INPUT_TAGGING_MESSAGE="MyProduct v2.0.0"
@ -490,7 +490,7 @@ cat_github_output() {
assert_success assert_success
assert_line "INPUT_TAG: v2.0.0" assert_line "INPUT_TAG_NAME: v2.0.0"
assert_line "::debug::Create tag v2.0.0: MyProduct v2.0.0" assert_line "::debug::Create tag v2.0.0: MyProduct v2.0.0"
assert_line "::debug::Push commit to remote branch a-new-branch" assert_line "::debug::Push commit to remote branch a-new-branch"
@ -643,7 +643,7 @@ cat_github_output() {
assert_line "INPUT_FILE_PATTERN: ." assert_line "INPUT_FILE_PATTERN: ."
assert_line "INPUT_COMMIT_OPTIONS: " assert_line "INPUT_COMMIT_OPTIONS: "
assert_line "::debug::Apply commit options " assert_line "::debug::Apply commit options "
assert_line "INPUT_TAG: " assert_line "INPUT_TAG_NAME: "
assert_line "INPUT_TAGGING_MESSAGE: " assert_line "INPUT_TAGGING_MESSAGE: "
assert_line "Neither tag nor tag message is set. No tag will be added." assert_line "Neither tag nor tag message is set. No tag will be added."
assert_line "INPUT_PUSH_OPTIONS: " assert_line "INPUT_PUSH_OPTIONS: "
@ -702,7 +702,7 @@ cat_github_output() {
assert_line "INPUT_FILE_PATTERN: ." assert_line "INPUT_FILE_PATTERN: ."
assert_line "INPUT_COMMIT_OPTIONS: " assert_line "INPUT_COMMIT_OPTIONS: "
assert_line "::debug::Apply commit options " assert_line "::debug::Apply commit options "
assert_line "INPUT_TAG: " assert_line "INPUT_TAG_NAME: "
assert_line "INPUT_TAGGING_MESSAGE: " assert_line "INPUT_TAGGING_MESSAGE: "
assert_line "Neither tag nor tag message is set. No tag will be added." assert_line "Neither tag nor tag message is set. No tag will be added."
assert_line "INPUT_PUSH_OPTIONS: " assert_line "INPUT_PUSH_OPTIONS: "
@ -1035,7 +1035,7 @@ cat_github_output() {
assert_line "INPUT_FILE_PATTERN: ." assert_line "INPUT_FILE_PATTERN: ."
assert_line "INPUT_COMMIT_OPTIONS: " assert_line "INPUT_COMMIT_OPTIONS: "
assert_line "::debug::Apply commit options " assert_line "::debug::Apply commit options "
assert_line "INPUT_TAG: " assert_line "INPUT_TAG_NAME: "
assert_line "INPUT_TAGGING_MESSAGE: " assert_line "INPUT_TAGGING_MESSAGE: "
assert_line "Neither tag nor tag message is set. No tag will be added." assert_line "Neither tag nor tag message is set. No tag will be added."
assert_line "INPUT_PUSH_OPTIONS: " assert_line "INPUT_PUSH_OPTIONS: "
@ -1123,7 +1123,7 @@ END
@test "it creates a tag if create_git_tag_only is set to true and a message has been supplied" { @test "it creates a tag if create_git_tag_only is set to true and a message has been supplied" {
INPUT_CREATE_GIT_TAG_ONLY=true INPUT_CREATE_GIT_TAG_ONLY=true
INPUT_TAG=v1.0.0 INPUT_TAG_NAME=v1.0.0
INPUT_TAGGING_MESSAGE="MyProduct v1.0.0" INPUT_TAGGING_MESSAGE="MyProduct v1.0.0"
run git_auto_commit run git_auto_commit
@ -1153,14 +1153,14 @@ END
@test "it output no tagging message supplied if no tagging message is set but create_git_tag_only is set to true" { @test "it output no tagging message supplied if no tagging message is set but create_git_tag_only is set to true" {
INPUT_CREATE_GIT_TAG_ONLY=true INPUT_CREATE_GIT_TAG_ONLY=true
INPUT_TAG="" INPUT_TAG_NAME=""
INPUT_TAGGING_MESSAGE="" INPUT_TAGGING_MESSAGE=""
run git_auto_commit run git_auto_commit
assert_success assert_success
assert_line "INPUT_TAG: " assert_line "INPUT_TAG_NAME: "
assert_line "INPUT_TAGGING_MESSAGE: " assert_line "INPUT_TAGGING_MESSAGE: "
assert_line "Neither tag nor tag message is set. No tag will be added." assert_line "Neither tag nor tag message is set. No tag will be added."
assert_line "::debug::Create git tag only" assert_line "::debug::Create git tag only"
@ -1452,7 +1452,7 @@ END
assert_success assert_success
assert_line "INPUT_TAG: " assert_line "INPUT_TAG_NAME: "
assert_line "INPUT_TAGGING_MESSAGE: v1.0.0" assert_line "INPUT_TAGGING_MESSAGE: v1.0.0"
assert_line "::debug::Create tag v1.0.0: v1.0.0" assert_line "::debug::Create tag v1.0.0: v1.0.0"
@ -1474,7 +1474,7 @@ END
} }
@test "Set a tag only" { @test "Set a tag only" {
INPUT_TAG="v1.0.0" INPUT_TAG_NAME="v1.0.0"
touch "${FAKE_LOCAL_REPOSITORY}"/new-file-{1,2,3}.txt touch "${FAKE_LOCAL_REPOSITORY}"/new-file-{1,2,3}.txt
@ -1482,7 +1482,7 @@ END
assert_success assert_success
assert_line "INPUT_TAG: v1.0.0" assert_line "INPUT_TAG_NAME: v1.0.0"
assert_line "INPUT_TAGGING_MESSAGE: " assert_line "INPUT_TAGGING_MESSAGE: "
assert_line "::debug::Create tag v1.0.0: v1.0.0" assert_line "::debug::Create tag v1.0.0: v1.0.0"