Tag v4.10.0

Add "disable_globbing" option to prevent shell from expanding filenames

CHANGELOG.md

@@ -4,11 +4,35 @@ 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/)
 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/v4.8.0...HEAD)
+## [Unreleased](https://github.com/stefanzweifel/git-auto-commit-action/compare/v4.10.0...HEAD)
 
 > TBD
 
 
+## [v4.10.0](https://github.com/stefanzweifel/git-auto-commit-action/compare/v4.9.2...v4.10.0) - 2021-04-12
+
+### Added
+- Add `disable_globbing` option [#153](https://github.com/stefanzweifel/git-auto-commit-action/issues/153), [#154](https://github.com/stefanzweifel/git-auto-commit-action/pull/154)
+
+
+## [v4.9.2](https://github.com/stefanzweifel/git-auto-commit-action/compare/v4.9.1...v4.9.2) - 2021-03-04
+
+### Fixes
+- Push created annotated tags to remote by using `--follow-tags` and `--atomic` instead of just `--tags` [#146](https://github.com/stefanzweifel/git-auto-commit-action/pull/146)
+
+
+## [v4.9.1](https://github.com/stefanzweifel/git-auto-commit-action/compare/v4.9.0...v4.9.1) - 2021-02-23
+
+### Changed
+- Revert changes made in v4.9.0. A branch will no longer be automatically generated. [#144](https://github.com/stefanzweifel/git-auto-commit-action/pull/144)
+
+
+## [v4.9.0](https://github.com/stefanzweifel/git-auto-commit-action/compare/v4.8.0...v4.9.0) - 2021-02-20
+
+### Changed
+- Automatically create branch if a branch with the given name does not exist [#140](https://github.com/stefanzweifel/git-auto-commit-action/pull/140)
+
+
 ## [v4.8.0](https://github.com/stefanzweifel/git-auto-commit-action/compare/v4.7.2...v4.8.0) - 2020-12-15
 
 ### Added

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2019 Stefan Zweifel
+Copyright (c) 2021 Stefan Zweifel
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -13,6 +13,8 @@ By default, the commit is made in the name of "GitHub Actions" and co-authored b
 This Action has been inspired and adapted from the [auto-commit](https://github.com/cds-snc/github-actions/tree/master/auto-commit
 )-Action of the Canadian Digital Service and this [commit](https://github.com/elstudio/actions-js-build/blob/41d604d6e73d632e22eac40df8cc69b5added04b/commit/entrypoint.sh)-Action by Eric Johnson.
 
+If you want to learn more how this Action works under the hood, check out [this article](https://michaelheap.com/git-auto-commit/) by Michael Heap.
+
 ## Usage
 
 Add the following step at the end of your job, after other steps that might add or change files.
@@ -67,7 +69,10 @@ This is a more extended example with all possible options.
     skip_dirty_check: true    
     
     # Optional: Skip internal call to `git fetch`
-    skip_fetch: true
+    skip_fetch: true    
+    
+    # Optional: Prevents the shell from expanding filenames. Details: https://www.gnu.org/software/bash/manual/html_node/Filename-Expansion.html
+    disable_globbing: true
 ```
 
 ## Example
@@ -143,7 +148,7 @@ You have to do this to avoid that the `checkout`-Action clones your repository i
 ### Commits of this Action do not trigger new Workflow runs
 
 The resulting commit **will not trigger** another GitHub Actions Workflow run.
-This is due to [limititations set by GitHub](https://help.github.com/en/actions/reference/events-that-trigger-workflows#triggering-new-workflows-using-a-personal-access-token).
+This is due to [limitations set by GitHub](https://help.github.com/en/actions/reference/events-that-trigger-workflows#triggering-new-workflows-using-a-personal-access-token).
 
 > When you use the repository's GITHUB_TOKEN to perform tasks on behalf of the GitHub Actions app, events triggered by the GITHUB_TOKEN will not create a new workflow run. This prevents you from accidentally creating recursive workflow runs.
 

action.yml

@@ -52,6 +52,9 @@ inputs:
     description: Skip the call to git-fetch.
     required: false
     default: false
+  disable_globbing:
+    description: Stop the shell from expanding filenames (https://www.gnu.org/software/bash/manual/html_node/Filename-Expansion.html)
+    default: false
 
 outputs:
   changes_detected:

entrypoint.sh

@@ -2,6 +2,10 @@
 
 set -eu
 
+if "$INPUT_DISABLE_GLOBBING"; then
+    set -o noglob;
+fi
+
 _main() {
     _switch_to_repository
 
@@ -104,7 +108,7 @@ _push_to_github() {
         if [ -n "$INPUT_TAGGING_MESSAGE" ]
         then
             echo "::debug::git push origin --tags";
-            git push origin --tags ${INPUT_PUSH_OPTIONS:+"${INPUT_PUSH_OPTIONS_ARRAY[@]}"};
+            git push origin --follow-tags --atomic ${INPUT_PUSH_OPTIONS:+"${INPUT_PUSH_OPTIONS_ARRAY[@]}"};
         else
             echo "::debug::git push origin";
             git push origin ${INPUT_PUSH_OPTIONS:+"${INPUT_PUSH_OPTIONS_ARRAY[@]}"};
@@ -112,7 +116,7 @@ _push_to_github() {
 
     else
         echo "::debug::Push commit to remote branch $INPUT_BRANCH";
-        git push --set-upstream origin "HEAD:$INPUT_BRANCH" --tags ${INPUT_PUSH_OPTIONS:+"${INPUT_PUSH_OPTIONS_ARRAY[@]}"};
+        git push --set-upstream origin "HEAD:$INPUT_BRANCH" --follow-tags --atomic ${INPUT_PUSH_OPTIONS:+"${INPUT_PUSH_OPTIONS_ARRAY[@]}"};
     fi
 }
 

tests/git-auto-commit.bats

@@ -5,9 +5,9 @@ load '../node_modules/bats-assert/load'
 
 setup() {
     # Define Paths for local repository used during tests
-    export FAKE_LOCAL_REPOSITORY="${BATS_TEST_DIRNAME}/test_fake_local_repository"
-    export FAKE_REMOTE="${BATS_TEST_DIRNAME}/test_fake_remote_repository"
-    export FAKE_TEMP_LOCAL_REPOSITORY="${BATS_TEST_DIRNAME}/test_fake_temp_local_repository"
+    export FAKE_LOCAL_REPOSITORY="${BATS_TEST_DIRNAME}/tests_local_repository"
+    export FAKE_REMOTE="${BATS_TEST_DIRNAME}/tests_remote_repository"
+    export FAKE_TEMP_LOCAL_REPOSITORY="${BATS_TEST_DIRNAME}/tests_clone_of_remote_repository"
 
     # Set default INPUT variables used by the GitHub Action
     export INPUT_REPOSITORY="${FAKE_LOCAL_REPOSITORY}"
@@ -22,6 +22,7 @@ setup() {
     export INPUT_PUSH_OPTIONS=""
     export INPUT_SKIP_DIRTY_CHECK=false
     export INPUT_SKIP_FETCH=false
+    export INPUT_DISABLE_GLOBBING=false
 
     # Configure Git
     if [[ -z $(git config user.name) ]]; then
@@ -94,6 +95,26 @@ git_auto_commit() {
     assert_line "::debug::Push commit to remote branch master"
 }
 
+@test "It detects when files have been deleted, commits changes and pushes them to the remote repository" {
+    rm -rf "${FAKE_LOCAL_REPOSITORY}"/remote-files1.txt
+
+    run git_auto_commit
+
+    assert_success
+
+    assert_line "INPUT_REPOSITORY value: ${INPUT_REPOSITORY}"
+    assert_line "::set-output name=changes_detected::true"
+    assert_line "INPUT_BRANCH value: master"
+    assert_line "INPUT_FILE_PATTERN: ."
+    assert_line "INPUT_COMMIT_OPTIONS: "
+    assert_line "::debug::Apply commit options "
+    assert_line "INPUT_TAGGING_MESSAGE: "
+    assert_line "No tagging message supplied. No tag will be added."
+    assert_line "INPUT_PUSH_OPTIONS: "
+    assert_line "::debug::Apply push options "
+    assert_line "::debug::Push commit to remote branch master"
+}
+
 @test "It prints a 'Nothing to commit' message in a clean repository" {
     run git_auto_commit
 
@@ -205,6 +226,13 @@ git_auto_commit() {
 
     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 master)"
+    remote_sha="$(git rev-parse --verify --short origin/master)"
+
+    assert_equal $current_sha $remote_sha
 }
 
 @test "It applies INPUT_PUSH_OPTIONS when pushing commit to remote" {
@@ -311,3 +339,100 @@ git_auto_commit() {
 
     assert_line "::debug::git-fetch has not been executed"
 }
+
+@test "It pushes generated commit and tag to remote and actually updates the commit shas" {
+    INPUT_BRANCH=""
+    INPUT_TAGGING_MESSAGE="v2.0.0"
+
+    touch "${FAKE_LOCAL_REPOSITORY}"/new-file-{1,2,3}.txt
+
+    run git_auto_commit
+
+    assert_success
+
+    assert_line "INPUT_TAGGING_MESSAGE: v2.0.0"
+    assert_line "::debug::Create tag v2.0.0"
+    assert_line "::debug::git push origin --tags"
+
+    # Assert a tag v2.0.0 has been created
+    run git tag
+    assert_output v2.0.0
+
+    # Assert tag v2.0.0 has been pushed to remote
+    run git ls-remote --tags --refs
+    assert_output --partial refs/tags/v2.0.0
+
+    # Assert that branch "master" was updated on remote
+    current_sha="$(git rev-parse --verify --short master)"
+    remote_sha="$(git rev-parse --verify --short origin/master)"
+
+    assert_equal $current_sha $remote_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 master
+    git checkout -b a-new-branch
+    git checkout master
+
+    INPUT_BRANCH="a-new-branch"
+    INPUT_TAGGING_MESSAGE="v2.0.0"
+
+    touch "${FAKE_LOCAL_REPOSITORY}"/new-file-{1,2,3}.txt
+
+    run git_auto_commit
+
+    assert_success
+
+    assert_line "INPUT_TAGGING_MESSAGE: v2.0.0"
+    assert_line "::debug::Create tag v2.0.0"
+    assert_line "::debug::Push commit to remote branch a-new-branch"
+
+    # Assert a tag v2.0.0 has been created
+    run git tag
+    assert_output v2.0.0
+
+    # Assert tag v2.0.0 has been pushed to remote
+    run git ls-remote --tags --refs
+    assert_output --partial refs/tags/v2.0.0
+
+    # Assert that branch "a-new-branch" was updated on remote
+    current_sha="$(git rev-parse --verify --short a-new-branch)"
+    remote_sha="$(git rev-parse --verify --short origin/a-new-branch)"
+
+    assert_equal $current_sha $remote_sha
+}
+
+@test "It does not expand wildcard glob when using INPUT_PATTERN and INPUT_DISABLE_GLOBBING in git-status and git-add" {
+
+    # Create additional files in a nested directory structure
+    echo "Create Additional files";
+    touch "${FAKE_LOCAL_REPOSITORY}"/new-file-a.py
+    mkdir "${FAKE_LOCAL_REPOSITORY}"/nested
+    touch "${FAKE_LOCAL_REPOSITORY}"/nested/new-file-b.py
+
+    # Commit changes
+    echo "Commit changes before running git_auto_commit";
+    cd "${FAKE_LOCAL_REPOSITORY}";
+    git add . > /dev/null;
+    git commit --quiet -m "Init Remote Repository";
+    git push origin master > /dev/null;
+
+    # Make nested file dirty
+    echo "foo-bar" > "${FAKE_LOCAL_REPOSITORY}"/nested/new-file-b.py;
+
+    # ---
+
+    INPUT_FILE_PATTERN="*.py"
+    INPUT_DISABLE_GLOBBING=true
+
+    run git_auto_commit
+
+    assert_success
+
+    assert_line "INPUT_FILE_PATTERN: *.py"
+    assert_line "::debug::Push commit to remote branch master"
+
+    # Assert that the updated py file has been commited.
+    run git status
+    refute_output --partial 'nested/new-file-b.py'
+}