Compare commits

...

10 Commits

Author SHA1 Message Date
Stefan Zweifel
28e16e8177 Release preparations for v7 (#394) 2025-10-12 16:31:03 +02:00
Stefan Zweifel
698fd76863 Merge pull request #391 from EliasBoulharts/custom-tag-message 2025-10-12 15:13:29 +02:00
Stefan Zweifel
c40819ab3b Update README 2025-10-12 14:59:32 +02:00
Stefan Zweifel
d7ee275235 Change internal variable names 2025-10-12 14:37:32 +02:00
Stefan Zweifel
e8684eb0cd Fix Tests 2025-10-12 14:27:10 +02:00
Stefan Zweifel
19497011bb Merge branch 'master' into pr/391 2025-10-12 14:11:57 +02:00
Stefan Zweifel
a88dc49508 Merge pull request #388 from stefanzweifel/v7-next 2025-10-12 14:02:15 +02:00
Stefan Zweifel
a531deca6b Merge pull request #386 from stefanzweifel/dependabot/github_actions/actions/checkout-5 2025-10-12 13:40:50 +02:00
Elias Boulharts
e9f84b936b feature: allow using custom tag message
Signed-off-by: Elias Boulharts <elias@MacBook-Pro-de-Elias.local>
2025-09-24 12:15:10 +02:00
dependabot[bot]
7ddc571aec Bump actions/checkout from 4 to 5
Bumps [actions/checkout](https://github.com/actions/checkout) from 4 to 5.
- [Release notes](https://github.com/actions/checkout/releases)
- [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md)
- [Commits](https://github.com/actions/checkout/compare/v4...v5)

---
updated-dependencies:
- dependency-name: actions/checkout
  dependency-version: '5'
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-08-18 08:56:44 +00:00
9 changed files with 161 additions and 64 deletions

View File

@@ -16,7 +16,7 @@ jobs:
contents: write contents: write
steps: steps:
- uses: actions/checkout@v4 - uses: actions/checkout@v5
with: with:
ref: ${{ github.head_ref }} ref: ${{ github.head_ref }}

View File

@@ -9,7 +9,7 @@ jobs:
steps: steps:
- name: Checkout Code - name: Checkout Code
uses: actions/checkout@v4 uses: actions/checkout@v5
- name: Lint Code Base - name: Lint Code Base
uses: github/super-linter@v7 uses: github/super-linter@v7

View File

@@ -11,7 +11,7 @@ jobs:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v4 - uses: actions/checkout@v5
- name: Install testing dependencies - name: Install testing dependencies
run: yarn install run: yarn install

View File

@@ -16,7 +16,7 @@ jobs:
steps: steps:
- name: Checkout code - name: Checkout code
uses: actions/checkout@v4 uses: actions/checkout@v5
with: with:
ref: master ref: master
@@ -27,7 +27,7 @@ jobs:
latest-version: ${{ github.event.release.name }} latest-version: ${{ github.event.release.name }}
- name: Commit updated CHANGELOG - name: Commit updated CHANGELOG
uses: stefanzweifel/git-auto-commit-action@v6 uses: stefanzweifel/git-auto-commit-action@v7
with: with:
branch: master branch: master
commit_message: Update CHANGELOG commit_message: Update CHANGELOG

View File

@@ -19,7 +19,7 @@ Adding git-auto-commit to your Workflow only takes a couple lines of code.
2. Add the following step at the end of your job, after other steps that might add or change files. 2. Add the following step at the end of your job, after other steps that might add or change files.
```yaml ```yaml
- uses: stefanzweifel/git-auto-commit-action@v6 - uses: stefanzweifel/git-auto-commit-action@v7
``` ```
Your Workflow should look similar to this example. Your Workflow should look similar to this example.
@@ -39,7 +39,7 @@ jobs:
contents: write contents: write
steps: steps:
- uses: actions/checkout@v4 - uses: actions/checkout@v5
with: with:
ref: ${{ github.head_ref }} ref: ${{ github.head_ref }}
@@ -47,7 +47,7 @@ jobs:
# … # …
# Commit all changed files back to the repository # Commit all changed files back to the repository
- uses: stefanzweifel/git-auto-commit-action@v6 - uses: stefanzweifel/git-auto-commit-action@v7
``` ```
> [!NOTE] > [!NOTE]
@@ -56,7 +56,7 @@ jobs:
The following is an extended example with all available options. The following is an extended example with all available options.
```yaml ```yaml
- uses: stefanzweifel/git-auto-commit-action@v6 - uses: stefanzweifel/git-auto-commit-action@v7
with: with:
# Optional. Commit message for the created commit. # Optional. Commit message for the created commit.
# Defaults to "Apply automatic changes" # Defaults to "Apply automatic changes"
@@ -85,10 +85,15 @@ The following is an extended example with all available options.
commit_user_name: My GitHub Actions Bot # defaults to "github-actions[bot]" commit_user_name: My GitHub Actions Bot # defaults to "github-actions[bot]"
commit_user_email: my-github-actions-bot@example.org # defaults to "41898282+github-actions[bot]@users.noreply.github.com" commit_user_email: my-github-actions-bot@example.org # defaults to "41898282+github-actions[bot]@users.noreply.github.com"
commit_author: Author <actions@github.com> # defaults to "username <numeric_id+username@users.noreply.github.com>", where "numeric_id" and "username" belong to the author of the commit that triggered the run commit_author: Author <actions@github.com> # defaults to "username <numeric_id+username@users.noreply.github.com>", where "numeric_id" and "username" belong to the author of the commit that triggered the run
# Optional. Tag name to be created in the local repository and
# pushed to the remote repository on the defined branch.
# 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_name: 'v1.0.0'
# Optional. Tag name being created in the local repository and # Optional. Message to annotate the created tag with.
# pushed to remote repository and defined branch. # 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: 'v1.0.0' 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
# dirty. See https://git-scm.com/docs/git-status#_options # dirty. See https://git-scm.com/docs/git-status#_options
@@ -119,7 +124,7 @@ The following is an extended example with all available options.
create_branch: true create_branch: true
# Optional. Creates a new tag and pushes it to remote without creating a commit. # 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 create_git_tag_only: false
``` ```
@@ -150,14 +155,14 @@ jobs:
contents: write contents: write
steps: steps:
- uses: actions/checkout@v4 - uses: actions/checkout@v5
with: with:
ref: ${{ github.head_ref }} ref: ${{ github.head_ref }}
- name: Run php-cs-fixer - name: Run php-cs-fixer
uses: docker://oskarstark/php-cs-fixer-ga uses: docker://oskarstark/php-cs-fixer-ga
- uses: stefanzweifel/git-auto-commit-action@v6 - uses: stefanzweifel/git-auto-commit-action@v7
with: with:
commit_message: Apply php-cs-fixer changes commit_message: Apply php-cs-fixer changes
``` ```
@@ -179,7 +184,7 @@ You can use these outputs to trigger other Actions in your Workflow run based on
### Example ### Example
```yaml ```yaml
- uses: stefanzweifel/git-auto-commit-action@v6 - uses: stefanzweifel/git-auto-commit-action@v7
id: auto-commit-action #mandatory for the output to show up in ${{ steps }} id: auto-commit-action #mandatory for the output to show up in ${{ steps }}
with: with:
commit_message: Apply php-cs-fixer changes commit_message: Apply php-cs-fixer changes
@@ -215,7 +220,7 @@ You must use `action/checkout@v2` or later versions to check out the repository.
In non-`push` events, such as `pull_request`, make sure to specify the `ref` to check out: In non-`push` events, such as `pull_request`, make sure to specify the `ref` to check out:
```yaml ```yaml
- uses: actions/checkout@v4 - uses: actions/checkout@v5
with: with:
ref: ${{ github.head_ref }} ref: ${{ github.head_ref }}
``` ```
@@ -233,7 +238,7 @@ You can change this by creating a new [Personal Access Token (PAT)](https://gith
storing the token as a secret in your repository and then passing the new token to the [`actions/checkout`](https://github.com/actions/checkout#usage) Action step. storing the token as a secret in your repository and then passing the new token to the [`actions/checkout`](https://github.com/actions/checkout#usage) Action step.
```yaml ```yaml
- uses: actions/checkout@v4 - uses: actions/checkout@v5
with: with:
token: ${{ secrets.PAT }} token: ${{ secrets.PAT }}
``` ```
@@ -279,7 +284,7 @@ The example below can be used as a starting point to generate a multiline commit
# Quick and dirty step to get rid of the temporary file holding the commit message # Quick and dirty step to get rid of the temporary file holding the commit message
- run: rm -rf commitmessage.txt - run: rm -rf commitmessage.txt
- uses: stefanzweifel/git-auto-commit-action@v6 - uses: stefanzweifel/git-auto-commit-action@v7
id: commit id: commit
with: with:
commit_message: ${{ steps.commit_message_step.outputs.commit_message }} commit_message: ${{ steps.commit_message_step.outputs.commit_message }}
@@ -303,7 +308,7 @@ As git-auto-commit by default does not use **your** username and email when crea
git_commit_gpgsign: true git_commit_gpgsign: true
- name: "Commit and push changes" - name: "Commit and push changes"
uses: stefanzweifel/git-auto-commit-action@v6 uses: stefanzweifel/git-auto-commit-action@v7
with: with:
commit_author: "${{ steps.import-gpg.outputs.name }} <${{ steps.import-gpg.outputs.email }}>" commit_author: "${{ steps.import-gpg.outputs.name }} <${{ steps.import-gpg.outputs.email }}>"
commit_user_name: ${{ steps.import-gpg.outputs.name }} commit_user_name: ${{ steps.import-gpg.outputs.name }}
@@ -366,7 +371,7 @@ jobs:
contents: write contents: write
steps: steps:
- uses: actions/checkout@v4 - uses: actions/checkout@v5
with: with:
# Checkout the fork/head-repository and push changes to the fork. # Checkout the fork/head-repository and push changes to the fork.
# If you skip this, the base repository will be checked out and changes # If you skip this, the base repository will be checked out and changes
@@ -380,7 +385,7 @@ jobs:
- name: Run php-cs-fixer - name: Run php-cs-fixer
uses: docker://oskarstark/php-cs-fixer-ga uses: docker://oskarstark/php-cs-fixer-ga
- uses: stefanzweifel/git-auto-commit-action@v6 - uses: stefanzweifel/git-auto-commit-action@v7
``` ```
For more information about running Actions on forks, see [this announcement from GitHub](https://github.blog/2020-08-03-github-actions-improvements-for-fork-and-pull-request-workflows/). For more information about running Actions on forks, see [this announcement from GitHub](https://github.blog/2020-08-03-github-actions-improvements-for-fork-and-pull-request-workflows/).
@@ -415,7 +420,7 @@ The steps in your workflow might look like this:
echo "message=$(git log -1 --pretty=%s)" >> $GITHUB_OUTPUT echo "message=$(git log -1 --pretty=%s)" >> $GITHUB_OUTPUT
echo "author=$(git log -1 --pretty=\"%an <%ae>\")" >> $GITHUB_OUTPUT echo "author=$(git log -1 --pretty=\"%an <%ae>\")" >> $GITHUB_OUTPUT
- uses: stefanzweifel/git-auto-commit-action@v6 - uses: stefanzweifel/git-auto-commit-action@v7
with: with:
commit_author: ${{ steps.last-commit.outputs.author }} commit_author: ${{ steps.last-commit.outputs.author }}
commit_message: ${{ steps.last-commit.outputs.message }} commit_message: ${{ steps.last-commit.outputs.message }}
@@ -458,7 +463,7 @@ If you create a personal access token (classic), apply the `repo` and `workflow`
If you create a fine-grained personal access token, apply the `Contents`-permissions. If you create a fine-grained personal access token, apply the `Contents`-permissions.
```yaml ```yaml
- uses: actions/checkout@v4 - uses: actions/checkout@v5
with: with:
# We pass the "PAT" secret to the checkout action; if no PAT secret is available to the workflow runner (eg. Dependabot) we fall back to the default "GITHUB_TOKEN". # We pass the "PAT" secret to the checkout action; if no PAT secret is available to the workflow runner (eg. Dependabot) we fall back to the default "GITHUB_TOKEN".
token: ${{ secrets.PAT || secrets.GITHUB_TOKEN }} token: ${{ secrets.PAT || secrets.GITHUB_TOKEN }}
@@ -472,7 +477,7 @@ You can learn more about Personal Access Token in the [GitHub documentation](htt
If you go the "force pushes" route, you have to enable force pushes to a protected branch (see [documentation](https://help.github.com/en/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)) and update your Workflow to use force push like this. If you go the "force pushes" route, you have to enable force pushes to a protected branch (see [documentation](https://help.github.com/en/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)) and update your Workflow to use force push like this.
```yaml ```yaml
- uses: stefanzweifel/git-auto-commit-action@v6 - uses: stefanzweifel/git-auto-commit-action@v7
with: with:
commit_message: Apply php-cs-fixer changes commit_message: Apply php-cs-fixer changes
push_options: --force push_options: --force
@@ -502,7 +507,7 @@ This is due to the fact, that the `*.md`-glob is expanded before sending it to `
To fix this add `disable_globbing: true` to your Workflow. To fix this add `disable_globbing: true` to your Workflow.
```yaml ```yaml
- uses: stefanzweifel/git-auto-commit-action@v6 - uses: stefanzweifel/git-auto-commit-action@v7
with: with:
file_pattern: '*.md' file_pattern: '*.md'
disable_globbing: true disable_globbing: true
@@ -530,7 +535,7 @@ yarn test
We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/stefanzweifel/git-auto-commit-action/tags). We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/stefanzweifel/git-auto-commit-action/tags).
We also provide major version tags to make it easier to always use the latest release of a major version. For example, you can use `stefanzweifel/git-auto-commit-action@v6` to always use the latest release of the current major version. We also provide major version tags to make it easier to always use the latest release of a major version. For example, you can use `stefanzweifel/git-auto-commit-action@v7` to always use the latest release of the current major version.
(More information about this [here](https://help.github.com/en/actions/building-actions/about-actions#versioning-your-action).) (More information about this [here](https://help.github.com/en/actions/building-actions/about-actions#versioning-your-action).)
## Credits ## Credits

View File

@@ -1,5 +1,12 @@
# Upgrading # Upgrading
## From v6 to v7
The previously removed options `create_branch`, `skip_fetch`, and `skip_checkout` have been reintroduced in git-auto-commit v7. If you had removed these options from your workflows when upgrading to v6, you can now add them back if needed.
Tagging a commit has been reworked. In addition to the existing `tagging_message`-option, a new `tag_name` option has been added. If you were using `tagging_message`, you can continue to do so, but if you want to specify a custom tag name and tag message, you can now use the `tag_name` and `tagging_message` option.
(Specifying a `tagging_message` without a `tag_name` will create a tag with the name and message both set to the value of `tagging_message`.)
## From v5 to v6 ## From v5 to v6
The following options have been removed from git-auto-commit and can be removed from your workflows. The following options have been removed from git-auto-commit and can be removed from your workflows.

View File

@@ -44,8 +44,12 @@ 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_name:
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: tagging_message:
description: Message used to create a new git tag with the commit. Keep this empty, if no tag should be created. description: Tagging message 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: ''
push_options: push_options:

View File

@@ -176,14 +176,17 @@ _local_commit() {
} }
_tag_commit() { _tag_commit() {
echo "INPUT_TAG_NAME: ${INPUT_TAG_NAME}"
echo "INPUT_TAGGING_MESSAGE: ${INPUT_TAGGING_MESSAGE}" echo "INPUT_TAGGING_MESSAGE: ${INPUT_TAGGING_MESSAGE}"
if [ -n "$INPUT_TAGGING_MESSAGE" ] if [ -n "$INPUT_TAG_NAME" ] || [ -n "$INPUT_TAGGING_MESSAGE" ]; then
then INTERNAL_TAG=${INPUT_TAG_NAME:-$INPUT_TAGGING_MESSAGE}
_log "debug" "Create tag $INPUT_TAGGING_MESSAGE"; INTERNAL_TAGGING_MESSAGE=${INPUT_TAGGING_MESSAGE:-$INPUT_TAG_NAME}
git -c user.name="$INPUT_COMMIT_USER_NAME" -c user.email="$INPUT_COMMIT_USER_EMAIL" tag -a "$INPUT_TAGGING_MESSAGE" -m "$INPUT_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"
else else
echo "No tagging message supplied. No tag will be added."; echo "Neither tag nor tag message is set. No tag will be added.";
fi fi
} }
@@ -199,8 +202,8 @@ _push_to_github() {
if [ -z "$INPUT_BRANCH" ] if [ -z "$INPUT_BRANCH" ]
then then
# Only add `--tags` option, if `$INPUT_TAGGING_MESSAGE` is set # Only add `--tags` option, if `$INPUT_TAG_NAME` or `$INPUT_TAGGING_MESSAGE` is set
if [ -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[@]}"};

View File

@@ -32,6 +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_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
@@ -121,8 +122,9 @@ 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_NAME: "
assert_line "INPUT_TAGGING_MESSAGE: " assert_line "INPUT_TAGGING_MESSAGE: "
assert_line "No tagging message supplied. 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: "
assert_line "::debug::Apply push options " assert_line "::debug::Apply push options "
assert_line "::debug::Push commit to remote branch ${FAKE_DEFAULT_BRANCH}" assert_line "::debug::Push commit to remote branch ${FAKE_DEFAULT_BRANCH}"
@@ -144,8 +146,9 @@ 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_NAME: "
assert_line "INPUT_TAGGING_MESSAGE: " assert_line "INPUT_TAGGING_MESSAGE: "
assert_line "No tagging message supplied. 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: "
assert_line "::debug::Apply push options " assert_line "::debug::Apply push options "
assert_line "::debug::Push commit to remote branch ${FAKE_DEFAULT_BRANCH}" assert_line "::debug::Push commit to remote branch ${FAKE_DEFAULT_BRANCH}"
@@ -291,7 +294,8 @@ cat_github_output() {
} }
@test "It creates a tag with the commit" { @test "It creates a tag with the commit" {
INPUT_TAGGING_MESSAGE="v1.0.0" INPUT_TAG_NAME="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
@@ -299,13 +303,15 @@ cat_github_output() {
assert_success assert_success
assert_line "INPUT_TAGGING_MESSAGE: v1.0.0" assert_line "INPUT_TAG_NAME: v1.0.0"
assert_line "::debug::Create tag 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::Push commit to remote branch ${FAKE_DEFAULT_BRANCH}" assert_line "::debug::Push commit to remote branch ${FAKE_DEFAULT_BRANCH}"
# Assert a tag v1.0.0 has been created # Assert a tag v1.0.0 has been created
run git tag run git tag -n
assert_output v1.0.0 assert_output 'v1.0.0 MyProduct v1.0.0'
run git ls-remote --tags --refs run git ls-remote --tags --refs
assert_output --partial refs/tags/v1.0.0 assert_output --partial refs/tags/v1.0.0
@@ -386,9 +392,11 @@ cat_github_output() {
assert_equal $current_sha $remote_sha assert_equal $current_sha $remote_sha
} }
@test "It uses existing branch when INPUT_BRANCH is empty and INPUT_TAGGING_MESSAGE is set" { @test "It uses existing branch when INPUT_BRANCH is empty and INPUT_TAG is set" {
INPUT_BRANCH="" INPUT_BRANCH=""
INPUT_TAGGING_MESSAGE="v2.0.0" INPUT_TAG_NAME="v2.0.0"
INPUT_TAGGING_MESSAGE="MyProduct v2.0.0"
touch "${FAKE_LOCAL_REPOSITORY}"/new-file-{1,2,3}.txt touch "${FAKE_LOCAL_REPOSITORY}"/new-file-{1,2,3}.txt
@@ -396,8 +404,8 @@ cat_github_output() {
assert_success assert_success
assert_line "INPUT_TAGGING_MESSAGE: v2.0.0" assert_line "INPUT_TAG_NAME: v2.0.0"
assert_line "::debug::Create tag 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"
# Assert a tag v2.0.0 has been created # Assert a tag v2.0.0 has been created
@@ -437,7 +445,9 @@ 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_TAGGING_MESSAGE="v2.0.0" INPUT_TAG_NAME="v2.0.0"
INPUT_TAGGING_MESSAGE="MyProduct v2.0.0"
touch "${FAKE_LOCAL_REPOSITORY}"/new-file-{1,2,3}.txt touch "${FAKE_LOCAL_REPOSITORY}"/new-file-{1,2,3}.txt
@@ -445,8 +455,8 @@ cat_github_output() {
assert_success assert_success
assert_line "INPUT_TAGGING_MESSAGE: v2.0.0" assert_line "INPUT_TAG_NAME: v2.0.0"
assert_line "::debug::Create tag 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"
# Assert a tag v2.0.0 has been created # Assert a tag v2.0.0 has been created
@@ -470,7 +480,9 @@ cat_github_output() {
git checkout ${FAKE_DEFAULT_BRANCH} git checkout ${FAKE_DEFAULT_BRANCH}
INPUT_BRANCH="a-new-branch" INPUT_BRANCH="a-new-branch"
INPUT_TAGGING_MESSAGE="v2.0.0" INPUT_TAG_NAME="v2.0.0"
INPUT_TAGGING_MESSAGE="MyProduct v2.0.0"
touch "${FAKE_LOCAL_REPOSITORY}"/new-file-{1,2,3}.txt touch "${FAKE_LOCAL_REPOSITORY}"/new-file-{1,2,3}.txt
@@ -478,8 +490,8 @@ cat_github_output() {
assert_success assert_success
assert_line "INPUT_TAGGING_MESSAGE: v2.0.0" assert_line "INPUT_TAG_NAME: v2.0.0"
assert_line "::debug::Create tag 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"
# Assert a tag v2.0.0 has been created # Assert a tag v2.0.0 has been created
@@ -631,8 +643,9 @@ 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_NAME: "
assert_line "INPUT_TAGGING_MESSAGE: " assert_line "INPUT_TAGGING_MESSAGE: "
assert_line "No tagging message supplied. 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: "
assert_line "::debug::Apply push options " assert_line "::debug::Apply push options "
assert_line "::debug::Push commit to remote branch not-existend-branch" assert_line "::debug::Push commit to remote branch not-existend-branch"
@@ -689,8 +702,9 @@ 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_NAME: "
assert_line "INPUT_TAGGING_MESSAGE: " assert_line "INPUT_TAGGING_MESSAGE: "
assert_line "No tagging message supplied. 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: "
assert_line "::debug::Apply push options " assert_line "::debug::Apply push options "
assert_line "::debug::Push commit to remote branch existing-remote-branch" assert_line "::debug::Push commit to remote branch existing-remote-branch"
@@ -1021,8 +1035,9 @@ 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_NAME: "
assert_line "INPUT_TAGGING_MESSAGE: " assert_line "INPUT_TAGGING_MESSAGE: "
assert_line "No tagging message supplied. 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: "
assert_line "::debug::Apply push options " assert_line "::debug::Apply push options "
assert_line "::debug::Push commit to remote branch ${FAKE_DEFAULT_BRANCH}" assert_line "::debug::Push commit to remote branch ${FAKE_DEFAULT_BRANCH}"
@@ -1108,7 +1123,8 @@ 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_TAGGING_MESSAGE=v1.0.0 INPUT_TAG_NAME=v1.0.0
INPUT_TAGGING_MESSAGE="MyProduct v1.0.0"
run git_auto_commit run git_auto_commit
@@ -1116,8 +1132,8 @@ END
assert_line "::debug::Create git tag only" assert_line "::debug::Create git tag only"
assert_line "::debug::Create tag v1.0.0" assert_line "::debug::Create tag v1.0.0: MyProduct v1.0.0"
refute_line "No tagging message supplied. No tag will be added." refute_line "Neither tag nor tag message is set. No tag will be added."
assert_line "::debug::Apply push options " assert_line "::debug::Apply push options "
assert_line "::debug::Push commit to remote branch ${FAKE_DEFAULT_BRANCH}" assert_line "::debug::Push commit to remote branch ${FAKE_DEFAULT_BRANCH}"
@@ -1128,8 +1144,8 @@ END
refute_line -e "commit_hash=[0-9a-f]{40}$" refute_line -e "commit_hash=[0-9a-f]{40}$"
# Assert a tag v1.0.0 has been created # Assert a tag v1.0.0 has been created
run git tag run git tag -n
assert_output v1.0.0 assert_output 'v1.0.0 MyProduct v1.0.0'
run git ls-remote --tags --refs run git ls-remote --tags --refs
assert_output --partial refs/tags/v1.0.0 assert_output --partial refs/tags/v1.0.0
@@ -1137,14 +1153,16 @@ 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_NAME=""
INPUT_TAGGING_MESSAGE="" INPUT_TAGGING_MESSAGE=""
run git_auto_commit run git_auto_commit
assert_success assert_success
assert_line "INPUT_TAG_NAME: "
assert_line "INPUT_TAGGING_MESSAGE: " assert_line "INPUT_TAGGING_MESSAGE: "
assert_line "No tagging message supplied. 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"
run cat_github_output run cat_github_output
@@ -1209,7 +1227,7 @@ END
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_TAGGING_MESSAGE: " assert_line "INPUT_TAGGING_MESSAGE: "
assert_line "No tagging message supplied. 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: "
assert_line "::debug::Apply push options " assert_line "::debug::Apply push options "
assert_line "::debug::Push commit to remote branch not-existend-branch" assert_line "::debug::Push commit to remote branch not-existend-branch"
@@ -1250,7 +1268,7 @@ END
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_TAGGING_MESSAGE: " assert_line "INPUT_TAGGING_MESSAGE: "
assert_line "No tagging message supplied. 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: "
assert_line "::debug::Apply push options " assert_line "::debug::Apply push options "
assert_line "::debug::Push commit to remote branch not-existend-remote-branch" assert_line "::debug::Push commit to remote branch not-existend-remote-branch"
@@ -1311,7 +1329,7 @@ END
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_TAGGING_MESSAGE: " assert_line "INPUT_TAGGING_MESSAGE: "
assert_line "No tagging message supplied. 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: "
assert_line "::debug::Apply push options " assert_line "::debug::Apply push options "
assert_line "::debug::Push commit to remote branch existing-remote-branch" assert_line "::debug::Push commit to remote branch existing-remote-branch"
@@ -1424,3 +1442,63 @@ END
assert_equal $current_sha $remote_sha assert_equal $current_sha $remote_sha
} }
@test "Set a tag message only" {
INPUT_TAGGING_MESSAGE="v1.0.0"
touch "${FAKE_LOCAL_REPOSITORY}"/new-file-{1,2,3}.txt
run git_auto_commit
assert_success
assert_line "INPUT_TAG_NAME: "
assert_line "INPUT_TAGGING_MESSAGE: v1.0.0"
assert_line "::debug::Create tag v1.0.0: v1.0.0"
assert_line "::debug::Push commit to remote branch ${FAKE_DEFAULT_BRANCH}"
# Assert a tag v1.0.0 has been created
run git tag -n
assert_output 'v1.0.0 v1.0.0'
run git ls-remote --tags --refs
assert_output --partial refs/tags/v1.0.0
# Assert that the commit has been pushed with --force and
# sha values are equal on local and remote
current_sha="$(git rev-parse --verify --short ${FAKE_DEFAULT_BRANCH})"
remote_sha="$(git rev-parse --verify --short origin/${FAKE_DEFAULT_BRANCH})"
assert_equal $current_sha $remote_sha
}
@test "Set a tag only" {
INPUT_TAG_NAME="v1.0.0"
touch "${FAKE_LOCAL_REPOSITORY}"/new-file-{1,2,3}.txt
run git_auto_commit
assert_success
assert_line "INPUT_TAG_NAME: v1.0.0"
assert_line "INPUT_TAGGING_MESSAGE: "
assert_line "::debug::Create tag v1.0.0: v1.0.0"
assert_line "::debug::Push commit to remote branch ${FAKE_DEFAULT_BRANCH}"
# Assert a tag v1.0.0 has been created
run git tag -n
assert_output 'v1.0.0 v1.0.0'
run git ls-remote --tags --refs
assert_output --partial refs/tags/v1.0.0
# Assert that the commit has been pushed with --force and
# sha values are equal on local and remote
current_sha="$(git rev-parse --verify --short ${FAKE_DEFAULT_BRANCH})"
remote_sha="$(git rev-parse --verify --short origin/${FAKE_DEFAULT_BRANCH})"
assert_equal $current_sha $remote_sha
}