Create GitHub pull request

github.createPullRequest opens a pull request from a source branch to a target branch.

automations/create-github-pull-request.automation.ts

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

export default automation("Create GitHub pull request", () => {
  onDashboardRun({ title: "Create GitHub pull request" })
  github.createPullRequest({
    owner: "SentsCo",
    repository: "automate.ax",
    head: "feature/github-docs",
    base: "main",
    title: "Document GitHub integration",
    draft: true,
  })
})

Provide owner, repository, non-empty head, base, and title. Prefix head with owner: for a fork. For a cross-repository pull request where both repositories belong to the same organization, also set headRepository to the source repository name. Optional fields are Markdown body, draft, and maintainerCanModify. Optional second argument { account } selects the GitHub binding. Inputs accept compatible signals. Returns the created pull request’s id, number, title, and head ref and sha. GitHub rejects missing branches, identical source and target commits, and branch combinations inaccessible to the installation.

Built-in triggers

Built-in actions

Runtime utilities

Integrations

Create GitHub pull request