From b671ff26ce4b38f705e4b0ecaa4d646b5ea63d03 Mon Sep 17 00:00:00 2001 From: Isaac Halvorson Date: Thu, 15 Dec 2022 08:40:49 -0600 Subject: [PATCH] Replace usage of COMMITER with COMMITTER (#192) --- README.md | 20 ++++++++++---------- e2e/bitrise.yml | 12 ++++++------ gitclone/output.go | 4 ++-- gitclone/output_test.go | 4 ++-- step.yml | 4 ++-- 5 files changed, 22 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index b1a95363..b6ff274e 100644 --- a/README.md +++ b/README.md @@ -75,16 +75,16 @@ You can also run this step directly with [Bitrise CLI](https://github.com/bitris
Outputs -| Environment Variable | Description | -| --- | --- | -| `GIT_CLONE_COMMIT_HASH` | SHA hash of the checked-out commit. | -| `GIT_CLONE_COMMIT_MESSAGE_SUBJECT` | Commit message of the checked-out commit. | -| `GIT_CLONE_COMMIT_MESSAGE_BODY` | Commit message body of the checked-out commit. | -| `GIT_CLONE_COMMIT_COUNT` | Commit count after checkout. Count will only work properly if no `--depth` option is set. If `--depth` is set then the history truncated to the specified number of commits. Count will **not** fail but will be the clone depth. | -| `GIT_CLONE_COMMIT_AUTHOR_NAME` | Author of the checked-out commit. | -| `GIT_CLONE_COMMIT_AUTHOR_EMAIL` | Email of the checked-out commit. | -| `GIT_CLONE_COMMIT_COMMITER_NAME` | Committer name of the checked-out commit. | -| `GIT_CLONE_COMMIT_COMMITER_EMAIL` | Email of the checked-out commit. | +| Environment Variable | Description | +|------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `GIT_CLONE_COMMIT_HASH` | SHA hash of the checked-out commit. | +| `GIT_CLONE_COMMIT_MESSAGE_SUBJECT` | Commit message of the checked-out commit. | +| `GIT_CLONE_COMMIT_MESSAGE_BODY` | Commit message body of the checked-out commit. | +| `GIT_CLONE_COMMIT_COUNT` | Commit count after checkout. Count will only work properly if no `--depth` option is set. If `--depth` is set then the history truncated to the specified number of commits. Count will **not** fail but will be the clone depth. | +| `GIT_CLONE_COMMIT_AUTHOR_NAME` | Author of the checked-out commit. | +| `GIT_CLONE_COMMIT_AUTHOR_EMAIL` | Email of the checked-out commit. | +| `GIT_CLONE_COMMIT_COMMITTER_NAME` | Committer name of the checked-out commit. | +| `GIT_CLONE_COMMIT_COMMITTER_EMAIL` | Email of the checked-out commit. |
## 🙋 Contributing diff --git a/e2e/bitrise.yml b/e2e/bitrise.yml index 6e6db7e2..cfe7b176 100644 --- a/e2e/bitrise.yml +++ b/e2e/bitrise.yml @@ -517,8 +517,8 @@ workflows: check "GIT_CLONE_COMMIT_COUNT" "25" check "GIT_CLONE_COMMIT_AUTHOR_NAME" "Krisztian Dobmayer" check "GIT_CLONE_COMMIT_AUTHOR_EMAIL" "krisztian.dobmayer@bitrise.io" - check "GIT_CLONE_COMMIT_COMMITER_NAME" "Krisztian Dobmayer" - check "GIT_CLONE_COMMIT_COMMITER_EMAIL" "krisztian.dobmayer@bitrise.io" + check "GIT_CLONE_COMMIT_COMMITTER_NAME" "Krisztian Dobmayer" + check "GIT_CLONE_COMMIT_COMMITTER_EMAIL" "krisztian.dobmayer@bitrise.io" _check_too_long_message: steps: @@ -548,8 +548,8 @@ workflows: echo "GIT_CLONE_COMMIT_COUNT: ${GIT_CLONE_COMMIT_COUNT}" echo "GIT_CLONE_COMMIT_AUTHOR_NAME: ${GIT_CLONE_COMMIT_AUTHOR_NAME}" echo "GIT_CLONE_COMMIT_AUTHOR_EMAIL: ${GIT_CLONE_COMMIT_AUTHOR_EMAIL}" - echo "GIT_CLONE_COMMIT_COMMITER_NAME: ${GIT_CLONE_COMMIT_COMMITER_NAME}" - echo "GIT_CLONE_COMMIT_COMMITER_EMAIL: ${GIT_CLONE_COMMIT_COMMITER_EMAIL}" + echo "GIT_CLONE_COMMIT_COMMITTER_NAME: ${GIT_CLONE_COMMIT_COMMITTER_NAME}" + echo "GIT_CLONE_COMMIT_COMMITTER_EMAIL: ${GIT_CLONE_COMMIT_COMMITTER_EMAIL}" _setup: steps: @@ -579,8 +579,8 @@ workflows: envman unset --key GIT_CLONE_COMMIT_COUNT envman unset --key GIT_CLONE_COMMIT_AUTHOR_NAME envman unset --key GIT_CLONE_COMMIT_AUTHOR_EMAIL - envman unset --key GIT_CLONE_COMMIT_COMMITER_NAME - envman unset --key GIT_CLONE_COMMIT_COMMITER_EMAIL + envman unset --key GIT_CLONE_COMMIT_COMMITTER_NAME + envman unset --key GIT_CLONE_COMMIT_COMMITTER_EMAIL _run: steps: diff --git a/gitclone/output.go b/gitclone/output.go index 21e961a7..85962e21 100644 --- a/gitclone/output.go +++ b/gitclone/output.go @@ -10,8 +10,8 @@ import ( "github.com/bitrise-io/go-utils/v2/command" ) -const outputCommitterName = "GIT_CLONE_COMMIT_COMMITER_NAME" -const outputCommitterEmail = "GIT_CLONE_COMMIT_COMMITER_EMAIL" +const outputCommitterName = "GIT_CLONE_COMMIT_COMMITTER_NAME" +const outputCommitterEmail = "GIT_CLONE_COMMIT_COMMITTER_EMAIL" const outputCommitCount = "GIT_CLONE_COMMIT_COUNT" type gitOutput struct { diff --git a/gitclone/output_test.go b/gitclone/output_test.go index d2d82ef5..8b7c1b44 100644 --- a/gitclone/output_test.go +++ b/gitclone/output_test.go @@ -49,11 +49,11 @@ func Test_gitOutputs(t *testing.T) { gitCmd: gitCmd.Log("%b", "ref/tags/1.0.0"), }, { - envKey: "GIT_CLONE_COMMIT_COMMITER_NAME", + envKey: "GIT_CLONE_COMMIT_COMMITTER_NAME", gitCmd: gitCmd.Log("%cn", "ref/tags/1.0.0"), }, { - envKey: "GIT_CLONE_COMMIT_COMMITER_EMAIL", + envKey: "GIT_CLONE_COMMIT_COMMITTER_EMAIL", gitCmd: gitCmd.Log("%ce", "ref/tags/1.0.0"), }, { diff --git a/step.yml b/step.yml index 9c78a8fe..fbaf26f6 100644 --- a/step.yml +++ b/step.yml @@ -233,11 +233,11 @@ outputs: opts: title: Commit author email description: Email of the checked-out commit. -- GIT_CLONE_COMMIT_COMMITER_NAME: +- GIT_CLONE_COMMIT_COMMITTER_NAME: opts: title: Committer name description: Committer name of the checked-out commit. -- GIT_CLONE_COMMIT_COMMITER_EMAIL: +- GIT_CLONE_COMMIT_COMMITTER_EMAIL: opts: title: Committer email description: Email of the checked-out commit.