tibdex / github-backport Goto Github PK

when a PR is tagged to be backported to multiple branches if one of the backports fails the others are not executed and there is no message by backport bot.

examples can be found here

• qgis/QGIS#9691 (comment)
• qgis/QGIS#30071

removing and readding the labels will trigger further backports. also, it seems that the order with which the labels are set to the PR might be relevant. here an example where one bp failed and one succeeded.

• qgis/QGIS#30869

We've started using the app for the Zephyr Project:
zephyrproject-rtos/zephyr#15515

But unfortunately our CI seems to stumble onto an unknown Git ref that we have no idea where is coming from:

https://app.shippable.com/github/zephyrproject-rtos/zephyr/runs/39643/1/console

git checkout -f cherry-pick-backport-15261-to-v1.14-branch-4c757f0a-e2e6-4102-b293-b0a458199a1c --
fatal: invalid reference: cherry-pick-backport-15261-to-v1.14-branch-4c757f0a-e2e6-4102-b293-b0a458199a1c

Any ideas as to where this unknown ref is being fed to Shippable?

If a backport pull request already exists github-backport throws an error with this message: "Reference already exists"
More details:

{
    "name": "HttpError",
    "status": 422,
    "headers": { ... },
    "request": {
        "method": "POST",
        "url": "https://api.github.com/repos/sqren/backport-demo/git/refs",
        "headers": {
            "accept": "application/vnd.github.v3+json",
            "user-agent": "octokit-rest.js/18.0.3 octokit-core.js/3.1.1 Node.js/10.21.0 (darwin; x64)",
            "authorization": "token [REDACTED]",
            "content-type": "application/json; charset=utf-8"
        },
        "body": "{\"ref\":\"refs/heads/backport-to-6.3\",\"sha\":\"e812829351c83be297d48ad7f4788ccf73c4de26\"}",
        "request": {}
    },
    "documentation_url": "https://docs.github.com/rest/reference/git#create-a-reference"
}

My suggestion is to handle this by updating the existing PR by updating the reference with the latest sha from the base branch. This will make it possible to rebase an existing backport pull request.

This could perhaps be handled explicitly with a new option like allowRebase:

backportPullRequest({
  allowRebase: true
})

or force:

backportPullRequest({
  force: true
})

I'm getting the following error when running tsc

node_modules/github-backport/lib/index.d.ts:9:14 - error TS2709: Cannot use namespace 'Octokit' as a type.

9     octokit: Octokit;
               ~~~~~~~

Found 1 error.

Sometimes the user performing the backport does not have push access to the primary repository, and the backport branch should therefore be created in a fork.

The Github docs specifies how to create a cross-repo PR:

The name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace head with a user like this: username:branch.

I therefore tried to specify the head as:

backportPullRequest({
  head: `some-username:some-branch`,
});

But this throws an error:

refs/heads/some-username:some-branch is not a valid ref name.