Update GitHub pull request branch

github.updatePullRequestBranch updates a pull request’s head branch with changes from its base branch.

automations/update-github-pr-branch.automation.ts

import { automation } from "automate.ax"
import { github } from "automate.ax/github"

export default automation("Update GitHub pull request branch", () => {
  github.updatePullRequestBranch({
    expectedHeadSha: "current-head-sha",
    owner: "SentsCo",
    pullRequestNumber: 42,
    repository: "automate.ax",
  })
})

Provide the repository and pullRequestNumber. Optional expectedHeadSha prevents updating a branch that changed since you read it. Returns GitHub’s asynchronous message and url when present. GitHub may reject conflicting branches or repositories that disable update-branch. Requires Pull requests and Contents write permissions. For a pull request from a fork, the GitHub App installation must also have access to the head repository.

Built-in triggers

Built-in actions

Runtime utilities

Integrations

Update GitHub pull request branch