[Bug]: when cleaning up PRs with is_pr_cleanup: true, switches to main on PR cleanup #529

Activity

1. kanno41

   added

   bugSomething isn't workingSomething isn't working

   on Jun 5, 2024
2. AndreasAugustin

   assigned

   AndreasAugustin

   and

   kanno41

   and unassigned

   kanno41

   on Jun 5, 2024
3. AndreasAugustin commented on Jun 5, 2024

   

   AndreasAugustin

   on Jun 5, 2024

   Last edited by AndreasAugustin

   Owner

   More actions

   that is weird. Need to check it. Thanks for the report!

   Update:
   ok, issue seems clear related to docs https://cli.github.com/manual/gh_pr_close
   gh pr close -d is also deleting the local branch. Seems I tried to be smart and failed.. 😸

   Will try to provide a fix asap.

   Remark
   @kanno41 Can you give some more details why you are using is_force_push_pr: true? What is your use case? Actually the action won't push or create a new PR if there are no changes within the remote repository. For the force push you do not need to delete the branch first.
4. AndreasAugustin commented on Jun 5, 2024

   

   AndreasAugustin

   on Jun 5, 2024

   Owner

   More actions

   @all-contributors please add @kanno41 for bug
5. allcontributors commented on Jun 5, 2024

   

   allcontributorsbot

   on Jun 5, 2024 – with AllContributors

   Contributor

   More actions

   @AndreasAugustin

   I've put up a pull request to add @kanno41! 🎉
6. AndreasAugustin commented on Jun 6, 2024

   

   AndreasAugustin

   on Jun 6, 2024

   Owner

   More actions

   @kanno41 I think I understand the issue now. It is somehow an edge case.

   • You have set is_force_push_pr: true
   • there is already a PR available with the same branch (this happens when you do not have changes within remote repository, when there are changes available, all should be fine because it will create a new branch which is not existing remote yet)
   • the gh pr close -d will delete the local branch because it has the same name like remote

   As a intermediate mitigation action you can remove the is_force_push_pr: true parameter. Then at least the action does not fail anymore.

   For a bug fix I need to think about some options:

   • if is_force_push_pr: true then exclude the current local branch from the deletion list
   • if is_force_push_pr: true and there are no changes within base repo -> remove the -d flag -> when there are changes available in any next run, the branch cleanup will work again
   • some other options

   currently I need to think about the downsides of each option.
7. AndreasAugustin

   added a commit that references this issue on Jun 9, 2024

   fix(#529): 🐛 edge case with branch cleanup and force push

   ...

   89c8f08
8. AndreasAugustin commented on Jun 9, 2024

   

   AndreasAugustin

   on Jun 9, 2024

   Last edited by AndreasAugustin

   Owner

   More actions

   @kanno41 #534 should fix this issue. I need to test it.

   You can try the solution with

         - name: actions-template-sync
           # use here the related branch name
           uses: AndreasAugustin/actions-template-sync@#529
           with:
             source_repo_path: <owner/repo>
             upstream_branch: <target_branch> # defaults to main
             pr_labels: <label1>,<label2>[,...] # defaults to template_sync
             is_force_push_pr: true
             is_pr_cleanup: true

   It actually checks if the remote branch equals the local branch. If so, it skips the cleanup for that branch.
9. AndreasAugustin

   added 3 commits that reference this issue on Jun 16, 2024

   fix(#529): 🐛 edge case with branch cleanup and force push

   ...

   104d149

   Merge branch 'fix/#529' of github.com:AndreasAugustin/actions-templat…

   ...

   d1b4d54

   fix(#529): 🐛 edge case with branch cleanup and force push (#534)

   ...

   ab9498f
10. AndreasAugustin

    closed this as completedin #534on Jun 16, 2024