delete-branch: true doesn't delete the Branch

[mietzen]

Subject of the issue

delete-branch: true doesn't delete the branch after merge

Steps to reproduce

Set delete-branch: true and use auto merge to merge it:

      - name: Create Pull Request
        id: pr
        uses: peter-evans/create-pull-request@v4
        with:
          token: ${{ secrets.PUSH_TOKEN }}
          delete-branch: true
          title: '[Github Action Bot] Update'
          commit-message: Update
          committer: GitHub Action Bot <[email protected]>
          author: GitHub Action Bot <[email protected]>
          branch: auto-update
          branch-suffix: timestamp
          assignees: mietzen
          labels: |
            automated pr
            update

      - name: Automerge if possible
        if: steps.commit.outputs.change == 'yes' && steps.pr.outputs.pull-request-operation == 'created'
        uses: peter-evans/enable-pull-request-automerge@v2
        with:
          token: ${{ secrets.PUSH_TOKEN }}
          pull-request-number: ${{ steps.pr.outputs.pull-request-number }}
          merge-method: squash

[peter-evans]

Hi @mietzen

The delete-branch feature doesn't delete branches immediately on merge. (It can't do that because it would require the merge to somehow trigger the action.) The intention of the feature is that when the action next runs it will delete branches that don't have an active pull request associated with it.

If you want branches to be deleted immediately on merge then you should use GitHub's Automatically delete head branches feature in your repository settings.

[mietzen]

Thanks for clarification!

[fharper]

I'm not sure how to phrase this shortly, but it would be worth updating its description at https://github.com/peter-evans/create-pull-request#action-inputs :)

[dezren39]

Hi @mietzen

The delete-branch feature doesn't delete branches immediately on merge. (It can't do that because it would require the merge to somehow trigger the action.) The intention of the feature is that when the action next runs it will delete branches that don't have an active pull request associated with it.

If you want branches to be deleted immediately on merge then you should use GitHub's Automatically delete head branches feature in your repository settings.

this is an excellent description. i agree with @fharper that it should be in the readme/action-inputs. i had to search for this to figure out what it does.

[dezren39]

#2631