.github/workflows/rebase.yml: rebase for multiple branches #110843

zowoq · 2021-01-26T11:30:29Z

Motivation for this change

Things done

zowoq · 2021-01-29T05:10:33Z

Leaving this as a draft but it's ready for review. I'll rename the action when merging.

@cdepillabout You may find this useful for PRs that need rebasing onto haskell-updates?

@mweinelt IIRC you asked about using it for release branches?

Mic92 · 2021-01-29T09:25:13Z

.github/workflows/rebase-staging.yml


 jobs:
  rebase:
    runs-on: ubuntu-latest
-    if: github.repository_owner == 'NixOS' && github.event.issue.pull_request != '' && contains(github.event.comment.body, '/rebase-staging')
+    if: github.repository_owner == 'NixOS' && github.event.issue.pull_request != '' && contains(github.event.comment.body, '/rebase')


Should be even backwards compatible.

It's not. We're expecting /rebase <branch> with this (see the awk '{ print $2 }'), while previously we accepted /rebase-staging.

mweinelt · 2021-01-29T16:26:41Z

.github/workflows/rebase-staging.yml

+          COMMITS=$(jq -r '.commits' pr.json)
+          CURRENT_BASE=$(jq -r '.base.ref' pr.json)
+          PR_BRANCH=$(jq -r '.head.ref' pr.json)
+          COMMENT_BRANCH=$(echo ${{ github.event.comment.body }} | grep '/rebase' | awk '{print $2}')


This looks a bit fragile. Maybe only accept lines beginning with /rebase?

Suggested change

COMMENT_BRANCH=$(echo ${{ github.event.comment.body }} | grep '/rebase' | awk '{print $2}')

COMMENT_BRANCH=$(echo ${{ github.event.comment.body }} | grep -E '^/rebase' | awk '{print $2}')

mweinelt

Loving the idea, thank you for making it happen!

mweinelt

Looks pretty good IMO. I don't have much experience with GHA though.

cdepillabout · 2021-02-03T12:23:51Z

@zowoq Thanks for pinging me on this. This does look like it would be helpful for rebasing stuff on haskell-updates.

Although I'm not very familiar with these / commands using GitHub actions.

Does the /rebase command actually rebase a branch in a user's repo (and not just change the base branch on GitHub)?

I was under the impression that even people with the commit bit in a repo aren't able to rebase a branch in a user's repo (even if they checked the box allow maintainer to push to my branch or whatever). So I'm somewhat surprised that this functionality is available as a / command.

SuperSandro2000 · 2021-02-03T12:52:05Z

Does the /rebase command actually rebase a branch in a user's repo (and not just change the base branch on GitHub)?

Yes. Base branch can be changed on the website but the two actions need to happen at once or you ping a lot of people.

I used it multiple times already and it mostly worked.

zowoq · 2021-02-14T00:24:57Z

Once we've used this for a couple of weeks without any problems I'll see about getting a token added to the repo so we can drop the close/reopen hack.

I've added a check for Allow edits .. by maintainers / maintainer_can_modify as it seems like it might be a common error, some of the other failures look like problems with the gh tool itself or the runners environment.

- Error if the commenter doesn't have write access or maintainers can't edit the PR branch. - Close and comment on PR after rebase so that actions are run when it's reopened. This doesn't happen currently as we're using the default github token which isn't allowed to trigger other actions. - Disallow unwanted rebases. e.g. invalid branches, redundant rebases or rebasing permanent branches onto permanent branches.

zowoq · 2021-02-16T06:49:19Z

I just triggered this by accident by commenting on a PR with Updated{slash}rebased on master, we may need to change it to use something a bit more specific.

mweinelt · 2021-02-17T23:13:09Z

I tried rebasing on the same branch and for some reason that is prohibited.

Can't rebase 20.09/microcodeIntel from release-20.09 onto release-20.09 (PR:113521 COMMITS:1)

Rebasing became necessary when an eval error hit release-20.09 and allowing rebase onto the same base would've been useful.

zowoq · 2021-02-17T23:44:10Z

It's disabled it to simplify the action as the merge-base and change base API commands aren't needed in that case.

The action is intended to cover the more complicated cases that also require additional steps: an API call or manually changing the base branch.

TBH I don't think it's worthwhile having support for the same branch as the action only works for committers and it's simple (and quicker) to rebase a branch on HEAD as it only needs git commands.

mweinelt · 2021-02-17T23:56:38Z

The API calls could be conditional on whether the branches aren't the same, no?

I know this is an afterthought, but It would be an amazing convenience feature, allowing the bot to take care of rebasing to HEAD to let the CI reevaluate with fixes that are on the target branch.

The benefit of the command is that it is lazy, it can be issued when you see the necessity and you don't have to open a shell, fetch and checkout the relevant branch. I believe there is little harm in allowing this.

Granted the whole action is getting quite complex, but we're talking about incremental improvements here.

zowoq · 2021-02-18T00:09:35Z

The confusion about how to "properly" rebase across branches without the CODEOWNER spam has generated many discussion and issues. Even the IRC bot has a programmed response. It's worthwhile having the action to simplify it.

I don't see rebasing on HEAD it as an incremental improvement, it's an increase in complexity to address a use case that is already uncomplicated.

I don't think this needs to be supported as an action:

$ git fetch origin
$ gh pr checkout "$PR"
$ git rebase origin/HEAD
$ git push --force

cdepillabout · 2021-02-26T05:42:39Z

I don't see rebasing on HEAD it as an incremental improvement, it's an increase in complexity to address a use case that is already uncomplicated.

While I agree that increasing complexity is definitely something to watch out for, it would be great to be able to do more directly through the github UI.

For instance, in #114418 (comment), I tried to use the /rebase command to do a rebase on the same branch, but it failed. I had to do it through the CLI.

If this would work to do a rebase on the same base branch, then I could have merged in that PR without ever going to the CLI. This would have been slightly easier for me.

github-actions · 2021-02-26T05:42:53Z

Failed to rebase

zowoq · 2021-02-26T06:54:53Z

Okay, there's been a few of requests now for rebasing on the same branch, let's add it.

Currently it doesn't work with the close/reopen hack, we won't be able to reopen the PR because of "branch was force pushed or recreated". If we change the action to use a different token we avoid the need for close/reopen hack so that seems to be the easier option. I'll try to see about organising that in the next couple of days.

zowoq · 2021-05-27T08:12:29Z

... next couple of days.

Took a bit longer than I planned but I've opened a draft at #124560, also includes some other changes which will make the commands more reliable.

zowoq · 2021-06-08T10:45:16Z

PR to remove: #126192

zowoq requested a review from Mic92 as a code owner January 26, 2021 11:30

zowoq marked this pull request as draft January 26, 2021 11:30

zowoq added the 2.status: work-in-progress label Jan 26, 2021

ofborg bot added 6.topic: policy discussion 10.rebuild-darwin: 0 10.rebuild-linux: 0 labels Jan 26, 2021

Mic92 requested a review from SuperSandro2000 January 28, 2021 07:28

zowoq removed the 2.status: work-in-progress label Jan 29, 2021

zowoq mentioned this pull request Jan 29, 2021

.github/workflows: add rebase-staging.yml #107520

Merged

Mic92 reviewed Jan 29, 2021

View reviewed changes

Mic92 approved these changes Jan 29, 2021

View reviewed changes

mweinelt reviewed Jan 29, 2021

View reviewed changes

mweinelt approved these changes Jan 30, 2021

View reviewed changes

zowoq changed the title ~~.github/workflows/rebase-staging.yml: rebase for multiple branches~~ .github/workflows/rebase.yml: rebase for multiple branches Feb 14, 2021

zowoq marked this pull request as ready for review February 14, 2021 00:34

zowoq merged commit fc3b385 into NixOS:master Feb 14, 2021

zowoq deleted the actions-rebase branch February 14, 2021 01:16

mweinelt mentioned this pull request Feb 17, 2021

[20.09] microcodeIntel: 20201118 -> 20210216 #113521

Merged

9 tasks

zowoq mentioned this pull request Feb 22, 2021

python2.pkgs.xmpppy: remove + dependent packages #113933

Merged

10 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

.github/workflows/rebase.yml: rebase for multiple branches #110843

.github/workflows/rebase.yml: rebase for multiple branches #110843

zowoq commented Jan 26, 2021

zowoq commented Jan 29, 2021

Mic92 Jan 29, 2021

mweinelt Jan 30, 2021

mweinelt Jan 29, 2021

mweinelt left a comment

mweinelt left a comment

cdepillabout commented Feb 3, 2021

SuperSandro2000 commented Feb 3, 2021

zowoq commented Feb 14, 2021

zowoq commented Feb 16, 2021

mweinelt commented Feb 17, 2021

zowoq commented Feb 17, 2021

mweinelt commented Feb 17, 2021

zowoq commented Feb 18, 2021 •

edited

cdepillabout commented Feb 26, 2021

github-actions bot commented Feb 26, 2021

zowoq commented Feb 26, 2021

zowoq commented May 27, 2021

zowoq commented Jun 8, 2021

	COMMENT_BRANCH=$(echo ${{ github.event.comment.body }} \| grep '/rebase' \| awk '{print $2}')
	COMMENT_BRANCH=$(echo ${{ github.event.comment.body }} \| grep -E '^/rebase' \| awk '{print $2}')

.github/workflows/rebase.yml: rebase for multiple branches #110843

.github/workflows/rebase.yml: rebase for multiple branches #110843

Conversation

zowoq commented Jan 26, 2021

Motivation for this change

Things done

zowoq commented Jan 29, 2021

Mic92 Jan 29, 2021

Choose a reason for hiding this comment

mweinelt Jan 30, 2021

Choose a reason for hiding this comment

mweinelt Jan 29, 2021

Choose a reason for hiding this comment

mweinelt left a comment

Choose a reason for hiding this comment

mweinelt left a comment

Choose a reason for hiding this comment

cdepillabout commented Feb 3, 2021

SuperSandro2000 commented Feb 3, 2021

zowoq commented Feb 14, 2021

zowoq commented Feb 16, 2021

mweinelt commented Feb 17, 2021

zowoq commented Feb 17, 2021

mweinelt commented Feb 17, 2021

zowoq commented Feb 18, 2021 • edited

cdepillabout commented Feb 26, 2021

github-actions bot commented Feb 26, 2021

zowoq commented Feb 26, 2021

zowoq commented May 27, 2021

zowoq commented Jun 8, 2021

zowoq commented Feb 18, 2021 •

edited