diff --git a/README.md b/README.md index c88b356..651291b 100644 --- a/README.md +++ b/README.md @@ -62,9 +62,8 @@ The following is an extended example with all available options. # Defaults to "Apply automatic changes" commit_message: Automated Change - # Optional. Local and remote branch name where commit is going to be pushed - # to. Defaults to the current branch. - # You might need to set `create_branch: true` if the branch does not exist. + # Optional. Remote branch name where commit is going to be pushed to. + # Defaults to the current branch. branch: feature-123 # Optional. Options used by `git-commit`. @@ -105,19 +104,10 @@ The following is an extended example with all available options. # Optional. Disable dirty check and always try to create a commit and push 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. # Details: https://www.gnu.org/software/bash/manual/html_node/Filename-Expansion.html disable_globbing: true - - # Optional. Create given branch name in local and remote repository. - create_branch: true ``` Please note that the Action depends on `bash`. If you're using the Action in a job in combination with a custom Docker container, make sure that `bash` is installed. @@ -416,7 +406,6 @@ The steps in your workflow might look like this: commit_message: ${{ steps.last-commit.outputs.message }} commit_options: '--amend --no-edit' push_options: '--force' - skip_fetch: true ``` See discussion in [#159](https://github.com/stefanzweifel/git-auto-commit-action/issues/159#issuecomment-845347950) for details. diff --git a/action.yml b/action.yml index 8192c95..775dd2f 100644 --- a/action.yml +++ b/action.yml @@ -56,20 +56,9 @@ inputs: description: Skip the check if the git repository is dirty and always try to create a commit. required: 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: description: Stop the shell from expanding filenames (https://www.gnu.org/software/bash/manual/html_node/Filename-Expansion.html) 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 internal_git_binary: description: Internal use only! Path to git binary used to check if git is available. (Don't change this!) default: git diff --git a/entrypoint.sh b/entrypoint.sh index bff98e0..50a689f 100755 --- a/entrypoint.sh +++ b/entrypoint.sh @@ -35,8 +35,6 @@ _main() { _set_github_output "changes_detected" "true" - _switch_to_branch - _add_files # Check dirty state of repo again using git-diff. @@ -93,32 +91,6 @@ _git_is_dirty() { [ -n "$gitStatus" ] } -_switch_to_branch() { - echo "INPUT_BRANCH value: $INPUT_BRANCH"; - - # 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 - git fetch --depth=1; - fi - - # If `skip_checkout`-input is true, skip the entire checkout step. - if "$INPUT_SKIP_CHECKOUT"; then - _log "debug" "git-checkout will not be executed."; - else - # Create new local branch if `create_branch`-input is true - 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 -} - _add_files() { echo "INPUT_ADD_OPTIONS: ${INPUT_ADD_OPTIONS}"; _log "debug" "Apply add options ${INPUT_ADD_OPTIONS}"; @@ -164,6 +136,8 @@ _tag_commit() { _push_to_github() { + echo "INPUT_BRANCH value: $INPUT_BRANCH"; + echo "INPUT_PUSH_OPTIONS: ${INPUT_PUSH_OPTIONS}"; _log "debug" "Apply push options ${INPUT_PUSH_OPTIONS}"; diff --git a/tests/git-auto-commit.bats b/tests/git-auto-commit.bats index d08597c..9adeb99 100644 --- a/tests/git-auto-commit.bats +++ b/tests/git-auto-commit.bats @@ -34,10 +34,7 @@ setup() { export INPUT_TAGGING_MESSAGE="" export INPUT_PUSH_OPTIONS="" export INPUT_SKIP_DIRTY_CHECK=false - export INPUT_SKIP_FETCH=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 @@ -192,7 +189,6 @@ cat_github_output() { assert_failure assert_line "INPUT_REPOSITORY value: ${INPUT_REPOSITORY}" - assert_line "INPUT_BRANCH value: ${FAKE_DEFAULT_BRANCH}" assert_line "INPUT_FILE_PATTERN: ." assert_line "INPUT_COMMIT_OPTIONS: " assert_line "::debug::Apply commit options " @@ -409,32 +405,6 @@ cat_github_output() { 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" { INPUT_BRANCH="" INPUT_TAGGING_MESSAGE="v2.0.0" @@ -465,10 +435,6 @@ cat_github_output() { } @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_TAGGING_MESSAGE="v2.0.0" @@ -491,7 +457,7 @@ cat_github_output() { 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)" + current_sha="$(git rev-parse --verify --short ${FAKE_DEFAULT_BRANCH})" remote_sha="$(git rev-parse --verify --short origin/a-new-branch)" assert_equal $current_sha $remote_sha @@ -535,7 +501,6 @@ cat_github_output() { @test "it does not throw an error if not changes are detected and SKIP_DIRTY_CHECK is false" { INPUT_FILE_PATTERN="." INPUT_SKIP_DIRTY_CHECK=false - INPUT_SKIP_FETCH=false run git_auto_commit @@ -578,9 +543,8 @@ cat_github_output() { 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_CREATE_BRANCH=false run git branch refute_line --partial "not-existend-branch" @@ -592,25 +556,24 @@ cat_github_output() { run git_auto_commit - assert_failure + assert_success assert_line "INPUT_REPOSITORY value: ${INPUT_REPOSITORY}" assert_line "INPUT_BRANCH value: not-existend-branch" - assert_line "fatal: invalid reference: not-existend-branch" run git branch + assert_line --partial ${FAKE_DEFAULT_BRANCH} refute_line --partial "not-existend-branch" run git branch -r - refute_line --partial "origin/not-existend-branch" + assert_line --partial "origin/not-existend-branch" run cat_github_output 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_CREATE_BRANCH=true run git branch refute_line --partial "not-existend-branch" @@ -635,9 +598,12 @@ cat_github_output() { assert_line "::debug::Apply push options " 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 - 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 assert_line --partial "origin/not-existend-branch" @@ -646,13 +612,11 @@ cat_github_output() { 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 ${FAKE_DEFAULT_BRANCH} INPUT_BRANCH="not-existend-remote-branch" - INPUT_CREATE_BRANCH=true run git branch assert_line --partial "not-existend-remote-branch" @@ -677,6 +641,11 @@ cat_github_output() { assert_line "::debug::Apply push options " 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 assert_line --partial "not-existend-remote-branch" @@ -688,8 +657,7 @@ cat_github_output() { 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 cd $FAKE_TEMP_LOCAL_REPOSITORY git checkout -b "existing-remote-branch" @@ -706,7 +674,6 @@ cat_github_output() { cd $FAKE_LOCAL_REPOSITORY INPUT_BRANCH="existing-remote-branch" - INPUT_CREATE_BRANCH=true run git branch refute_line --partial "existing-remote-branch" @@ -734,13 +701,14 @@ cat_github_output() { assert_line "::debug::Push commit to remote branch existing-remote-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 assert_line --partial "origin/existing-remote-branch" # 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)" assert_equal $current_sha $remote_sha @@ -750,7 +718,7 @@ cat_github_output() { 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 cd $FAKE_TEMP_LOCAL_REPOSITORY git checkout -b "existing-remote-branch" @@ -767,7 +735,6 @@ cat_github_output() { cd $FAKE_LOCAL_REPOSITORY INPUT_BRANCH="existing-remote-branch" - INPUT_CREATE_BRANCH=true run git branch refute_line --partial "existing-remote-branch" @@ -782,23 +749,24 @@ cat_github_output() { 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 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 assert_line --partial "origin/existing-remote-branch" # 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)" 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 cd $FAKE_TEMP_LOCAL_REPOSITORY @@ -818,7 +786,7 @@ cat_github_output() { 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. run git branch refute_line --partial "new-branch" @@ -830,16 +798,13 @@ cat_github_output() { run git_auto_commit - assert_success + assert_failure assert_line "INPUT_BRANCH value: new-branch" assert_line --partial "::debug::Push commit to remote branch new-branch" - # Assert that branch "new-branch" was updated on remote - current_sha="$(git rev-parse --verify --short new-branch)" - remote_sha="$(git rev-parse --verify --short origin/new-branch)" - - assert_equal $current_sha $remote_sha + assert_line --partial "Updates were rejected because the remote contains work that you do" + assert_line --partial "This is usually caused by another repository pushing" } @test "throws fatal error if file pattern includes files that do not exist" { @@ -1004,7 +969,7 @@ cat_github_output() { assert_line --partial "Working tree clean. Nothing to commit." 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 run cat_github_output @@ -1038,7 +1003,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 "new-file-2.txt" - assert_line --partial "new-file-3.txt" + # assert_line --partial "new-file-3.txt" # Changes are detected run cat_github_output