Create GitHub pull request

createGitHubPullRequest opens a pull request from a source branch into a target branch.

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

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

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

owner, repository, non-empty head, base, and title are required. Prefix head with owner: for a fork. Optional fields are Markdown body, draft, maintainerCanModify, and account. Inputs accept compatible signals. Returns the complete created pull request. GitHub rejects missing branches, identical source and target commits, and branch combinations the installation cannot access.

⌘I

Get started

Concepts

Reference

Create GitHub pull request