Compare commits

...

38 Commits
v5 ... master

Author SHA1 Message Date
Stefan Zweifel
01d77ca6cb Merge pull request #382 from stefanzweifel/dependabot/github_actions/stefanzweifel/git-auto-commit-action-6 2025-06-16 09:45:04 +02:00
dependabot[bot]
6371fedd09 Bump stefanzweifel/git-auto-commit-action from 5 to 6
Bumps [stefanzweifel/git-auto-commit-action](https://github.com/stefanzweifel/git-auto-commit-action) from 5 to 6.
- [Release notes](https://github.com/stefanzweifel/git-auto-commit-action/releases)
- [Changelog](https://github.com/stefanzweifel/git-auto-commit-action/blob/master/CHANGELOG.md)
- [Commits](https://github.com/stefanzweifel/git-auto-commit-action/compare/v5...v6)

---
updated-dependencies:
- dependency-name: stefanzweifel/git-auto-commit-action
  dependency-version: '6'
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-06-16 06:39:19 +00:00
Stefan Zweifel
f9017b24ee Update README to use v6 in examples 2025-06-13 16:47:49 +02:00
stefanzweifel
66f124b8c2 Update CHANGELOG 2025-06-11 11:27:36 +00:00
Stefan Zweifel
778341af66 Merge pull request #379 from stefanzweifel/disable-detached-state-check 2025-06-11 13:26:39 +02:00
Stefan Zweifel
33b203d92a Disable Check if Repo is in Detached State
Fixes #378
2025-06-11 13:22:17 +02:00
stefanzweifel
a82d80a75f Update CHANGELOG 2025-06-10 18:44:47 +00:00
Stefan Zweifel
3cc016cfc8 Merge pull request #375 from stefanzweifel/v6-next 2025-06-10 20:19:14 +02:00
Stefan Zweifel
ddb7ae4159 Merge pull request #376 from Dreamsorcerer/patch-1 2025-06-02 21:38:08 +02:00
Stefan Zweifel
b001e5f0ff Apply suggestions from code review 2025-06-02 21:37:45 +02:00
Sam Bull
6494dc61d3 Fix PAT instructions with Dependabot 2025-05-28 15:08:30 +01:00
Stefan Zweifel
76180511d9 Add deprecated inputs to fix unbound variable issue 2025-05-28 11:37:04 +02:00
Stefan Zweifel
ae114628ea Merge pull request #371 from stefanzweifel/dependabot/npm_and_yarn/bats-1.12.0 2025-05-19 09:43:11 +02:00
dependabot[bot]
3058f91afb Bump bats from 1.11.1 to 1.12.0
Bumps [bats](https://github.com/bats-core/bats-core) from 1.11.1 to 1.12.0.
- [Release notes](https://github.com/bats-core/bats-core/releases)
- [Changelog](https://github.com/bats-core/bats-core/blob/master/docs/CHANGELOG.md)
- [Commits](https://github.com/bats-core/bats-core/compare/v1.11.1...v1.12.0)

---
updated-dependencies:
- dependency-name: bats
  dependency-version: 1.12.0
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-05-19 06:08:17 +00:00
Stefan Zweifel
8ddf02de71 Add git-auto-commit to warning text 2025-05-03 16:03:43 +02:00
Stefan Zweifel
e7955f713c Emit warning if deprecated/removed options are used 2025-05-03 15:51:01 +02:00
Stefan Zweifel
739fd03b2d Merge branch 'master' into v6-next 2025-05-03 10:31:03 +02:00
stefanzweifel
af302a9c63 Update CHANGELOG 2025-04-19 08:40:01 +00:00
Stefan Zweifel
ed295bd35a Merge pull request #357 from stefanzweifel/v6-detect-detached-state 2025-02-05 18:00:42 +01:00
Stefan Zweifel
bd434eed48 Use ref checkout properly 2025-02-05 17:34:26 +01:00
Stefan Zweifel
1666a49083 Use ref in auto-commit workflow 2025-02-05 17:27:23 +01:00
Stefan Zweifel
1d986f74dd Improve Error Message 2025-02-05 17:17:19 +01:00
Stefan Zweifel
ad56d4eb46 Throw error if repo is in detached state 2025-02-05 17:14:02 +01:00
Stefan Zweifel
9fa4cb99cf Merge pull request #314 from stefanzweifel/v6/remove-local-branch-switch 2025-02-05 16:01:10 +01:00
Stefan Zweifel
cec27bde37 Fix Typo 2025-02-05 15:59:51 +01:00
Stefan Zweifel
244febd79d Add UPGRADING.md 2025-02-05 15:57:55 +01:00
Stefan Zweifel
7f171889c8 Remove removed options from README 2023-12-20 20:20:24 +01:00
Stefan Zweifel
76f415fb30 Remove skip_fetch, skip_checkout and create_branch 2023-12-20 20:19:38 +01:00
Stefan Zweifel
3e796a0146 Update Assertion 2023-12-20 20:13:20 +01:00
Stefan Zweifel
e833d4f211 Remove _switch_to_branch function 2023-12-20 20:10:12 +01:00
Stefan Zweifel
0aca01a1ef Remove no longer used input options from tests 2023-12-20 20:09:59 +01:00
Stefan Zweifel
03fddc470c Temp disable assertions 2023-12-20 20:09:40 +01:00
Stefan Zweifel
ef7ed32535 Remove no longer needed tests 2023-12-20 20:03:21 +01:00
Stefan Zweifel
9062db8404 Update Tests 2023-12-19 21:00:32 +01:00
Stefan Zweifel
80052f0645 Update Tests 2023-12-19 20:45:55 +01:00
Stefan Zweifel
3b8231379d Update Tests 2023-12-19 20:34:56 +01:00
Stefan Zweifel
d9307b5e8c Update Test 2023-12-19 20:13:01 +01:00
Stefan Zweifel
aa2cec9c08 Don't switch local branches 2023-12-19 20:11:39 +01:00
10 changed files with 182 additions and 135 deletions

View File

@@ -17,6 +17,8 @@ jobs:
steps: steps:
- uses: actions/checkout@v4 - uses: actions/checkout@v4
with:
ref: ${{ github.head_ref }}
- name: Use git-auto-commit-action - name: Use git-auto-commit-action
id: "auto-commit-action" id: "auto-commit-action"

View File

@@ -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@v5 uses: stefanzweifel/git-auto-commit-action@v6
with: with:
branch: master branch: master
commit_message: Update CHANGELOG commit_message: Update CHANGELOG

View File

@@ -5,10 +5,41 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html). and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
## [Unreleased](https://github.com/stefanzweifel/git-auto-commit-action/compare/v5.1.0...HEAD) ## [Unreleased](https://github.com/stefanzweifel/git-auto-commit-action/compare/v6.0.1...HEAD)
> TBD > TBD
## [v6.0.1](https://github.com/stefanzweifel/git-auto-commit-action/compare/v6.0.0...v6.0.1) - 2025-06-11
### Fixed
- Disable Check if Repo is in Detached State ([#379](https://github.com/stefanzweifel/git-auto-commit-action/pull/379)) [@stefanzweifel](https://github.com/@stefanzweifel)
## [v6.0.0](https://github.com/stefanzweifel/git-auto-commit-action/compare/v5.2.0...v6.0.0) - 2025-06-10
### Added
- Throw error early if repository is in a detached state ([#357](https://github.com/stefanzweifel/git-auto-commit-action/pull/357))
### Fixed
- Fix PAT instructions with Dependabot ([#376](https://github.com/stefanzweifel/git-auto-commit-action/pull/376)) [@Dreamsorcerer](https://github.com/@Dreamsorcerer)
### Removed
- Remove support for `create_branch`, `skip_checkout`, `skip_Fetch` ([#314](https://github.com/stefanzweifel/git-auto-commit-action/pull/314))
## [v5.2.0](https://github.com/stefanzweifel/git-auto-commit-action/compare/v5.1.0...v5.2.0) - 2025-04-19
### Added
- Add `create_git_tag_only` option to skip commiting and always create a git-tag. ([#364](https://github.com/stefanzweifel/git-auto-commit-action/pull/364)) [@zMynxx](https://github.com/@zMynxx)
- Add Test for `create_git_tag_only` feature ([#367](https://github.com/stefanzweifel/git-auto-commit-action/pull/367)) [@stefanzweifel](https://github.com/@stefanzweifel)
### Fixed
- docs: Update README.md per #354 ([#361](https://github.com/stefanzweifel/git-auto-commit-action/pull/361)) [@rasa](https://github.com/@rasa)
## [v5.1.0](https://github.com/stefanzweifel/git-auto-commit-action/compare/v5.0.1...v5.1.0) - 2025-01-11 ## [v5.1.0](https://github.com/stefanzweifel/git-auto-commit-action/compare/v5.0.1...v5.1.0) - 2025-01-11
### Changed ### Changed

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@v5 - uses: stefanzweifel/git-auto-commit-action@v6
``` ```
Your Workflow should look similar to this example. Your Workflow should look similar to this example.
@@ -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@v5 - uses: stefanzweifel/git-auto-commit-action@v6
``` ```
> [!NOTE] > [!NOTE]
@@ -56,15 +56,14 @@ 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@v5 - uses: stefanzweifel/git-auto-commit-action@v6
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"
commit_message: Automated Change commit_message: Automated Change
# Optional. Local and remote branch name where commit is going to be pushed # Optional. Remote branch name where commit is going to be pushed to.
# to. Defaults to the current branch. # Defaults to the current branch.
# You might need to set `create_branch: true` if the branch does not exist.
branch: feature-123 branch: feature-123
# Optional. Options used by `git-commit`. # Optional. Options used by `git-commit`.
@@ -106,19 +105,10 @@ The following is an extended example with all available options.
# Optional. Disable dirty check and always try to create a commit and push # Optional. Disable dirty check and always try to create a commit and push
skip_dirty_check: true skip_dirty_check: true
# Optional. Skip internal call to `git fetch`
skip_fetch: true
# Optional. Skip internal call to `git checkout`
skip_checkout: true
# Optional. Prevents the shell from expanding filenames. # Optional. Prevents the shell from expanding filenames.
# Details: https://www.gnu.org/software/bash/manual/html_node/Filename-Expansion.html # Details: https://www.gnu.org/software/bash/manual/html_node/Filename-Expansion.html
disable_globbing: true disable_globbing: true
# Optional. Create given branch name in local and remote repository.
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 with `tagging_message`.
create_git_tag_only: false create_git_tag_only: false
@@ -158,7 +148,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@v5 - uses: stefanzweifel/git-auto-commit-action@v6
with: with:
commit_message: Apply php-cs-fixer changes commit_message: Apply php-cs-fixer changes
``` ```
@@ -180,7 +170,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@v5 - uses: stefanzweifel/git-auto-commit-action@v6
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
@@ -280,7 +270,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@v5 - uses: stefanzweifel/git-auto-commit-action@v6
id: commit id: commit
with: with:
commit_message: ${{ steps.commit_message_step.outputs.commit_message }} commit_message: ${{ steps.commit_message_step.outputs.commit_message }}
@@ -304,7 +294,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@v5 uses: stefanzweifel/git-auto-commit-action@v6
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 }}
@@ -381,7 +371,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@v5 - uses: stefanzweifel/git-auto-commit-action@v6
``` ```
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/).
@@ -416,13 +406,12 @@ 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@v5 - uses: stefanzweifel/git-auto-commit-action@v6
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 }}
commit_options: '--amend --no-edit' commit_options: '--amend --no-edit'
push_options: '--force' push_options: '--force'
skip_fetch: true
``` ```
See discussion in [#159](https://github.com/stefanzweifel/git-auto-commit-action/issues/159#issuecomment-845347950) for details. See discussion in [#159](https://github.com/stefanzweifel/git-auto-commit-action/issues/159#issuecomment-845347950) for details.
@@ -461,17 +450,19 @@ If you create a fine-grained personal access token, apply the `Contents`-permiss
```yaml ```yaml
- uses: actions/checkout@v4 - uses: actions/checkout@v4
with: with:
token: ${{ secrets.PAT }} # 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 }}
``` ```
You can learn more about Personal Access Token in the [GitHub documentation](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token). You can learn more about Personal Access Token in the [GitHub documentation](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token).
> [!TIP] > [!TIP]
> If you're working in an organisation, and you don't want to create the PAT from your personal account, we recommend using a bot-account for such tokens. > If you're working in an organisation, and you don't want to create the PAT from your personal account, we recommend using a bot-account for such tokens.
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@v5 - uses: stefanzweifel/git-auto-commit-action@v6
with: with:
commit_message: Apply php-cs-fixer changes commit_message: Apply php-cs-fixer changes
push_options: --force push_options: --force
@@ -501,7 +492,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@v5 - uses: stefanzweifel/git-auto-commit-action@v6
with: with:
file_pattern: '*.md' file_pattern: '*.md'
disable_globbing: true disable_globbing: true
@@ -529,7 +520,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@v5` 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@v6` 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

10
UPGRADING.md Normal file
View File

@@ -0,0 +1,10 @@
# Upgrading
## From v5 to v6
The following options have been removed from git-auto-commit and can be removed from your workflows.
- `create_branch` (git-auto-commit no longer switches branches locally during a workflow run)
- `skip_fetch`
- `skip_checkout`

View File

@@ -56,20 +56,9 @@ inputs:
description: Skip the check if the git repository is dirty and always try to create a commit. description: Skip the check if the git repository is dirty and always try to create a commit.
required: false required: false
default: false default: false
skip_fetch:
description: Skip the call to git-fetch.
required: false
default: false
skip_checkout:
description: Skip the call to git-checkout.
required: false
default: false
disable_globbing: disable_globbing:
description: Stop the shell from expanding filenames (https://www.gnu.org/software/bash/manual/html_node/Filename-Expansion.html) description: Stop the shell from expanding filenames (https://www.gnu.org/software/bash/manual/html_node/Filename-Expansion.html)
default: false default: false
create_branch:
description: Create new branch with the name of `branch`-input in local and remote repository, if it doesn't exist yet.
default: false
create_git_tag_only: create_git_tag_only:
description: Perform a clean git tag and push, without commiting anything description: Perform a clean git tag and push, without commiting anything
required: false required: false
@@ -77,6 +66,18 @@ inputs:
internal_git_binary: internal_git_binary:
description: Internal use only! Path to git binary used to check if git is available. (Don't change this!) description: Internal use only! Path to git binary used to check if git is available. (Don't change this!)
default: git default: git
skip_fetch:
description: "Deprecated: skip_fetch has been removed in v6. It does not have any effect anymore."
required: false
default: false
skip_checkout:
description: "Deprecated: skip_checkout has been removed in v6. It does not have any effect anymore."
required: false
default: false
create_branch:
description: "Deprecated: create_branch has been removed in v6. It does not have any effect anymore."
default: false
outputs: outputs:
changes_detected: changes_detected:

View File

@@ -27,9 +27,26 @@ _log() {
} }
_main() { _main() {
if "$INPUT_SKIP_FETCH"; then
_log "warning" "git-auto-commit: skip_fetch has been removed in v6. It does not have any effect anymore.";
fi
if "$INPUT_SKIP_CHECKOUT"; then
_log "warning" "git-auto-commit: skip_checkout has been removed in v6. It does not have any effect anymore.";
fi
if "$INPUT_CREATE_BRANCH"; then
_log "warning" "git-auto-commit: create_branch has been removed in v6. It does not have any effect anymore.";
fi
_check_if_git_is_available _check_if_git_is_available
_switch_to_repository _switch_to_repository
_check_if_is_git_repository
# _check_if_repository_is_in_detached_state
if "$INPUT_CREATE_GIT_TAG_ONLY"; then if "$INPUT_CREATE_GIT_TAG_ONLY"; then
_log "debug" "Create git tag only"; _log "debug" "Create git tag only";
_set_github_output "create_git_tag_only" "true" _set_github_output "create_git_tag_only" "true"
@@ -39,8 +56,6 @@ _main() {
_set_github_output "changes_detected" "true" _set_github_output "changes_detected" "true"
_switch_to_branch
_add_files _add_files
# Check dirty state of repo again using git-diff. # Check dirty state of repo again using git-diff.
@@ -90,36 +105,25 @@ _git_is_dirty() {
gitStatusMessage="$((git status -s $INPUT_STATUS_OPTIONS -- ${INPUT_FILE_PATTERN_EXPANDED:+${INPUT_FILE_PATTERN_EXPANDED[@]}} >/dev/null ) 2>&1)"; gitStatusMessage="$((git status -s $INPUT_STATUS_OPTIONS -- ${INPUT_FILE_PATTERN_EXPANDED:+${INPUT_FILE_PATTERN_EXPANDED[@]}} >/dev/null ) 2>&1)";
# shellcheck disable=SC2086 # shellcheck disable=SC2086
gitStatus="$(git status -s $INPUT_STATUS_OPTIONS -- ${INPUT_FILE_PATTERN_EXPANDED:+${INPUT_FILE_PATTERN_EXPANDED[@]}})"; gitStatus="$(git status -s $INPUT_STATUS_OPTIONS -- ${INPUT_FILE_PATTERN_EXPANDED:+${INPUT_FILE_PATTERN_EXPANDED[@]}})";
if [ $? -ne 0 ]; then
_log "error" "git-status failed with:<$gitStatusMessage>";
exit 1;
fi
[ -n "$gitStatus" ] [ -n "$gitStatus" ]
} }
_switch_to_branch() { _check_if_is_git_repository() {
echo "INPUT_BRANCH value: $INPUT_BRANCH"; if [ -d ".git" ]; then
_log "debug" "Repository found.";
# Fetch remote to make sure that repo can be switched to the right branch.
if "$INPUT_SKIP_FETCH"; then
_log "debug" "git-fetch will not be executed.";
else else
git fetch --depth=1; _log "error" "Not a git repository. Please make sure to run this action in a git repository. Adjust the `repository` input if necessary.";
exit 1;
fi fi
}
# If `skip_checkout`-input is true, skip the entire checkout step. _check_if_repository_is_in_detached_state() {
if "$INPUT_SKIP_CHECKOUT"; then if [ -z "$(git symbolic-ref HEAD)" ]
_log "debug" "git-checkout will not be executed."; then
_log "error" "Repository is in detached HEAD state. Please make sure you check out a branch. Adjust the `ref` input accordingly.";
exit 1;
else else
# Create new local branch if `create_branch`-input is true _log "debug" "Repository is on a branch.";
if "$INPUT_CREATE_BRANCH"; then
# shellcheck disable=SC2086
git checkout -B $INPUT_BRANCH --;
else
# Switch to branch from current Workflow run
# shellcheck disable=SC2086
git checkout $INPUT_BRANCH --;
fi
fi fi
} }
@@ -168,6 +172,8 @@ _tag_commit() {
_push_to_github() { _push_to_github() {
echo "INPUT_BRANCH value: $INPUT_BRANCH";
echo "INPUT_PUSH_OPTIONS: ${INPUT_PUSH_OPTIONS}"; echo "INPUT_PUSH_OPTIONS: ${INPUT_PUSH_OPTIONS}";
_log "debug" "Apply push options ${INPUT_PUSH_OPTIONS}"; _log "debug" "Apply push options ${INPUT_PUSH_OPTIONS}";

6
package-lock.json generated
View File

@@ -5,13 +5,15 @@
"packages": { "packages": {
"": { "": {
"devDependencies": { "devDependencies": {
"bats": "^1.11.1", "bats": "^1.12.0",
"bats-assert": "ztombol/bats-assert", "bats-assert": "ztombol/bats-assert",
"bats-support": "ztombol/bats-support" "bats-support": "ztombol/bats-support"
} }
}, },
"node_modules/bats": { "node_modules/bats": {
"version": "1.11.1", "version": "1.12.0",
"resolved": "https://registry.npmjs.org/bats/-/bats-1.12.0.tgz",
"integrity": "sha512-1HTv2n+fjn3bmY9SNDgmzS6bjoKtVlSK2pIHON5aSA2xaqGkZFoCCWP46/G6jm9zZ7MCi84mD+3Byw4t3KGwBg==",
"dev": true, "dev": true,
"license": "MIT", "license": "MIT",
"bin": { "bin": {

View File

@@ -1,6 +1,6 @@
{ {
"devDependencies": { "devDependencies": {
"bats": "^1.11.1", "bats": "^1.12.0",
"bats-assert": "ztombol/bats-assert", "bats-assert": "ztombol/bats-assert",
"bats-support": "ztombol/bats-support" "bats-support": "ztombol/bats-support"
}, },

View File

@@ -35,11 +35,13 @@ setup() {
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
export INPUT_DISABLE_GLOBBING=false
export INPUT_INTERNAL_GIT_BINARY=git
# Deprecated variables. Will be removed in future versions
export INPUT_CREATE_BRANCH=false
export INPUT_SKIP_FETCH=false export INPUT_SKIP_FETCH=false
export INPUT_SKIP_CHECKOUT=false export INPUT_SKIP_CHECKOUT=false
export INPUT_DISABLE_GLOBBING=false
export INPUT_CREATE_BRANCH=false
export INPUT_INTERNAL_GIT_BINARY=git
# Set GitHub environment variables used by the GitHub Action # Set GitHub environment variables used by the GitHub Action
temp_github_output_file=$(mktemp -t github_output_test.XXXXX) temp_github_output_file=$(mktemp -t github_output_test.XXXXX)
@@ -193,7 +195,6 @@ cat_github_output() {
assert_failure assert_failure
assert_line "INPUT_REPOSITORY value: ${INPUT_REPOSITORY}" assert_line "INPUT_REPOSITORY value: ${INPUT_REPOSITORY}"
assert_line "INPUT_BRANCH value: ${FAKE_DEFAULT_BRANCH}"
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 "
@@ -410,32 +411,6 @@ cat_github_output() {
assert_output --partial refs/tags/v2.0.0 assert_output --partial refs/tags/v2.0.0
} }
@test "If SKIP_FETCH is true git-fetch will not be called" {
touch "${FAKE_LOCAL_REPOSITORY}"/new-file-{1,2,3}.txt
INPUT_SKIP_FETCH=true
run git_auto_commit
assert_success
assert_line "::debug::git-fetch will not be executed."
}
@test "If SKIP_CHECKOUT is true git-checkout will not be called" {
touch "${FAKE_LOCAL_REPOSITORY}"/new-file-{1,2,3}.txt
INPUT_SKIP_CHECKOUT=true
run git_auto_commit
assert_success
assert_line "::debug::git-checkout will not be executed."
}
@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_TAGGING_MESSAGE="v2.0.0"
@@ -466,10 +441,6 @@ cat_github_output() {
} }
@test "It pushes generated commit and tag to remote branch and updates commit sha" { @test "It pushes generated commit and tag to remote branch and updates commit sha" {
# Create "a-new-branch"-branch and then immediately switch back to ${FAKE_DEFAULT_BRANCH}
git checkout -b a-new-branch
git checkout ${FAKE_DEFAULT_BRANCH}
INPUT_BRANCH="a-new-branch" INPUT_BRANCH="a-new-branch"
INPUT_TAGGING_MESSAGE="v2.0.0" INPUT_TAGGING_MESSAGE="v2.0.0"
@@ -492,7 +463,7 @@ cat_github_output() {
assert_output --partial refs/tags/v2.0.0 assert_output --partial refs/tags/v2.0.0
# Assert that branch "a-new-branch" was updated on remote # Assert that branch "a-new-branch" was updated on remote
current_sha="$(git rev-parse --verify --short a-new-branch)" current_sha="$(git rev-parse --verify --short ${FAKE_DEFAULT_BRANCH})"
remote_sha="$(git rev-parse --verify --short origin/a-new-branch)" remote_sha="$(git rev-parse --verify --short origin/a-new-branch)"
assert_equal $current_sha $remote_sha assert_equal $current_sha $remote_sha
@@ -536,7 +507,6 @@ cat_github_output() {
@test "it does not throw an error if not changes are detected and SKIP_DIRTY_CHECK is false" { @test "it does not throw an error if not changes are detected and SKIP_DIRTY_CHECK is false" {
INPUT_FILE_PATTERN="." INPUT_FILE_PATTERN="."
INPUT_SKIP_DIRTY_CHECK=false INPUT_SKIP_DIRTY_CHECK=false
INPUT_SKIP_FETCH=false
run git_auto_commit run git_auto_commit
@@ -579,9 +549,8 @@ cat_github_output() {
assert_line "changes_detected=true" assert_line "changes_detected=true"
} }
@test "script fails to push commit to new branch that does not exist yet" { @test "It pushes commit to new branch that does not exist yet" {
INPUT_BRANCH="not-existend-branch" INPUT_BRANCH="not-existend-branch"
INPUT_CREATE_BRANCH=false
run git branch run git branch
refute_line --partial "not-existend-branch" refute_line --partial "not-existend-branch"
@@ -593,25 +562,24 @@ cat_github_output() {
run git_auto_commit run git_auto_commit
assert_failure assert_success
assert_line "INPUT_REPOSITORY value: ${INPUT_REPOSITORY}" assert_line "INPUT_REPOSITORY value: ${INPUT_REPOSITORY}"
assert_line "INPUT_BRANCH value: not-existend-branch" assert_line "INPUT_BRANCH value: not-existend-branch"
assert_line "fatal: invalid reference: not-existend-branch"
run git branch run git branch
assert_line --partial ${FAKE_DEFAULT_BRANCH}
refute_line --partial "not-existend-branch" refute_line --partial "not-existend-branch"
run git branch -r run git branch -r
refute_line --partial "origin/not-existend-branch" assert_line --partial "origin/not-existend-branch"
run cat_github_output run cat_github_output
assert_line "changes_detected=true" assert_line "changes_detected=true"
} }
@test "It creates new local branch and pushes the new branch to remote" { @test "It does not create new local branch and pushes the commit to a new branch on remote" {
INPUT_BRANCH="not-existend-branch" INPUT_BRANCH="not-existend-branch"
INPUT_CREATE_BRANCH=true
run git branch run git branch
refute_line --partial "not-existend-branch" refute_line --partial "not-existend-branch"
@@ -636,9 +604,12 @@ cat_github_output() {
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"
# Assert that local repo is still on default branch and not on new branch.
run git branch run git branch
assert_line --partial "not-existend-branch" assert_line --partial ${FAKE_DEFAULT_BRANCH}
refute_line --partial "not-existend-branch"
# Assert branch has been created on remote
run git branch -r run git branch -r
assert_line --partial "origin/not-existend-branch" assert_line --partial "origin/not-existend-branch"
@@ -647,13 +618,11 @@ cat_github_output() {
assert_line -e "commit_hash=[0-9a-f]{40}$" assert_line -e "commit_hash=[0-9a-f]{40}$"
} }
@test "it does not create new local branch if local branch already exists" { @test "It does not create new local branch if local branch already exists" {
git checkout -b not-existend-remote-branch git checkout -b not-existend-remote-branch
git checkout ${FAKE_DEFAULT_BRANCH} git checkout ${FAKE_DEFAULT_BRANCH}
INPUT_BRANCH="not-existend-remote-branch" INPUT_BRANCH="not-existend-remote-branch"
INPUT_CREATE_BRANCH=true
run git branch run git branch
assert_line --partial "not-existend-remote-branch" assert_line --partial "not-existend-remote-branch"
@@ -678,6 +647,11 @@ cat_github_output() {
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"
# Assert checked out branch is still the same.
run git rev-parse --abbrev-ref HEAD
assert_line --partial ${FAKE_DEFAULT_BRANCH}
refute_line --partial "not-existend-remote-branch"
run git branch run git branch
assert_line --partial "not-existend-remote-branch" assert_line --partial "not-existend-remote-branch"
@@ -689,8 +663,7 @@ cat_github_output() {
assert_line -e "commit_hash=[0-9a-f]{40}$" assert_line -e "commit_hash=[0-9a-f]{40}$"
} }
@test "it creates new local branch and pushes branch to remote even if the remote branch already exists" { @test "It creates new local branch and pushes branch to remote even if the remote branch already exists" {
# Create `existing-remote-branch` on remote with changes the local repository does not yet have # Create `existing-remote-branch` on remote with changes the local repository does not yet have
cd $FAKE_TEMP_LOCAL_REPOSITORY cd $FAKE_TEMP_LOCAL_REPOSITORY
git checkout -b "existing-remote-branch" git checkout -b "existing-remote-branch"
@@ -707,7 +680,6 @@ cat_github_output() {
cd $FAKE_LOCAL_REPOSITORY cd $FAKE_LOCAL_REPOSITORY
INPUT_BRANCH="existing-remote-branch" INPUT_BRANCH="existing-remote-branch"
INPUT_CREATE_BRANCH=true
run git branch run git branch
refute_line --partial "existing-remote-branch" refute_line --partial "existing-remote-branch"
@@ -735,13 +707,14 @@ cat_github_output() {
assert_line "::debug::Push commit to remote branch existing-remote-branch" assert_line "::debug::Push commit to remote branch existing-remote-branch"
run git branch run git branch
assert_line --partial "existing-remote-branch" assert_line --partial ${FAKE_DEFAULT_BRANCH}
refute_line --partial "existing-remote-branch"
run git branch -r run git branch -r
assert_line --partial "origin/existing-remote-branch" assert_line --partial "origin/existing-remote-branch"
# Assert that branch "existing-remote-branch" was updated on remote # Assert that branch "existing-remote-branch" was updated on remote
current_sha="$(git rev-parse --verify --short existing-remote-branch)" current_sha="$(git rev-parse --verify --short ${FAKE_DEFAULT_BRANCH})"
remote_sha="$(git rev-parse --verify --short origin/existing-remote-branch)" remote_sha="$(git rev-parse --verify --short origin/existing-remote-branch)"
assert_equal $current_sha $remote_sha assert_equal $current_sha $remote_sha
@@ -751,7 +724,7 @@ cat_github_output() {
assert_line -e "commit_hash=[0-9a-f]{40}$" assert_line -e "commit_hash=[0-9a-f]{40}$"
} }
@test "script fails if new local branch is checked out and push fails as remote has newer commits than local" { @test "It fails if local branch is behind remote and when remote has newer commits" {
# Create `existing-remote-branch` on remote with changes the local repository does not yet have # Create `existing-remote-branch` on remote with changes the local repository does not yet have
cd $FAKE_TEMP_LOCAL_REPOSITORY cd $FAKE_TEMP_LOCAL_REPOSITORY
git checkout -b "existing-remote-branch" git checkout -b "existing-remote-branch"
@@ -768,7 +741,6 @@ cat_github_output() {
cd $FAKE_LOCAL_REPOSITORY cd $FAKE_LOCAL_REPOSITORY
INPUT_BRANCH="existing-remote-branch" INPUT_BRANCH="existing-remote-branch"
INPUT_CREATE_BRANCH=true
run git branch run git branch
refute_line --partial "existing-remote-branch" refute_line --partial "existing-remote-branch"
@@ -783,23 +755,24 @@ cat_github_output() {
assert_failure assert_failure
assert_line "hint: Updates were rejected because the tip of your current branch is behind" assert_line "hint: Updates were rejected because a pushed branch tip is behind its remote"
# Assert that branch exists locally and on remote # Assert that branch exists locally and on remote
run git branch run git branch
assert_line --partial "existing-remote-branch" assert_line --partial ${FAKE_DEFAULT_BRANCH}
refute_line --partial "existing-remote-branch"
run git branch -r run git branch -r
assert_line --partial "origin/existing-remote-branch" assert_line --partial "origin/existing-remote-branch"
# Assert that branch "existing-remote-branch" was not updated on remote # Assert that branch "existing-remote-branch" was not updated on remote
current_sha="$(git rev-parse --verify --short existing-remote-branch)" current_sha="$(git rev-parse --verify --short ${FAKE_DEFAULT_BRANCH})"
remote_sha="$(git rev-parse --verify --short origin/existing-remote-branch)" remote_sha="$(git rev-parse --verify --short origin/existing-remote-branch)"
refute [assert_equal $current_sha $remote_sha] refute [assert_equal $current_sha $remote_sha]
} }
@test "It pushes commit to remote if branch already exists and local repo is behind its remote counterpart" { @test "It fails to push commit to remote if branch already exists and local repo is behind its remote counterpart" {
# Create `new-branch` on remote with changes the local repository does not yet have # Create `new-branch` on remote with changes the local repository does not yet have
cd $FAKE_TEMP_LOCAL_REPOSITORY cd $FAKE_TEMP_LOCAL_REPOSITORY
@@ -819,7 +792,7 @@ cat_github_output() {
INPUT_BRANCH="new-branch" INPUT_BRANCH="new-branch"
# Assert that local remote does not know have "new-branch" locally nor does # Assert that local remote does not have a "new-branch"-branch nor does
# know about the remote branch. # know about the remote branch.
run git branch run git branch
refute_line --partial "new-branch" refute_line --partial "new-branch"
@@ -831,16 +804,13 @@ cat_github_output() {
run git_auto_commit run git_auto_commit
assert_success assert_failure
assert_line "INPUT_BRANCH value: new-branch" assert_line "INPUT_BRANCH value: new-branch"
assert_line --partial "::debug::Push commit to remote branch new-branch" assert_line --partial "::debug::Push commit to remote branch new-branch"
# Assert that branch "new-branch" was updated on remote assert_line --partial "Updates were rejected because the remote contains work that you do"
current_sha="$(git rev-parse --verify --short new-branch)" assert_line --partial "This is usually caused by another repository pushing"
remote_sha="$(git rev-parse --verify --short origin/new-branch)"
assert_equal $current_sha $remote_sha
} }
@test "throws fatal error if file pattern includes files that do not exist" { @test "throws fatal error if file pattern includes files that do not exist" {
@@ -1005,7 +975,7 @@ cat_github_output() {
assert_line --partial "Working tree clean. Nothing to commit." assert_line --partial "Working tree clean. Nothing to commit."
assert_line --partial "new-file-2.txt" assert_line --partial "new-file-2.txt"
assert_line --partial "new-file-3.txt" # assert_line --partial "new-file-3.txt"
# Changes are not detected # Changes are not detected
run cat_github_output run cat_github_output
@@ -1039,7 +1009,7 @@ cat_github_output() {
assert_line --partial "warning: in the working copy of 'new-file-2.txt', LF will be replaced by CRLF the next time Git touches it" assert_line --partial "warning: in the working copy of 'new-file-2.txt', LF will be replaced by CRLF the next time Git touches it"
assert_line --partial "new-file-2.txt" assert_line --partial "new-file-2.txt"
assert_line --partial "new-file-3.txt" # assert_line --partial "new-file-3.txt"
# Changes are detected # Changes are detected
run cat_github_output run cat_github_output
@@ -1124,7 +1094,27 @@ END
run git_auto_commit run git_auto_commit
assert_failure; assert_failure;
assert_line "::error::git-status failed with:<fatal: not a git repository (or any of the parent directories): .git>" assert_line "::error::Not a git repository. Please make sure to run this action in a git repository. Adjust the `repository` input if necessary."
}
@test "It detects if the repository is in a detached state and exits with an error" {
skip
touch "${FAKE_LOCAL_REPOSITORY}"/new-file-{1,2,3}.txt
run git_auto_commit
assert_success
# Bring local repository into a detached state
prev_commit=$(git rev-parse HEAD~1);
git checkout "$prev_commit";
touch "${FAKE_TEMP_LOCAL_REPOSITORY}"/remote-files{4,5,6}.txt
run git_auto_commit
assert_failure;
assert_line "::error::Repository is in detached HEAD state. Please make sure you check out a branch. Adjust the `ref` input accordingly."
} }
@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" {
@@ -1177,3 +1167,17 @@ END
run git tag run git tag
assert_output "" assert_output ""
} }
@test "it shows warning message if any deprecated options are used" {
INPUT_SKIP_FETCH=true
INPUT_SKIP_CHECKOUT=true
INPUT_CREATE_BRANCH=true
run git_auto_commit
assert_success
assert_line "::warning::git-auto-commit: skip_fetch has been removed in v6. It does not have any effect anymore."
assert_line "::warning::git-auto-commit: skip_checkout has been removed in v6. It does not have any effect anymore."
assert_line "::warning::git-auto-commit: create_branch has been removed in v6. It does not have any effect anymore."
}