github.github.createpullrequest

Home > @runlightyear/github > GitHub > createPullRequest

GitHub.createPullRequest() method

Create a pull request

Signature:

createPullRequest(props: CreatePullRequestProps): Promise<HttpProxyResponse>;

Parameters

Parameter	Type	Description
props	CreatePullRequestProps	props

Returns:

Promise<HttpProxyResponse>

Example

Create a pull request

import { defineAction } from "@runlightyear/lightyear";
import { GitHub } from "@runlightyear/github";

defineAction({
  name: "createPullRequest",
  title: "Create Pull Request",
  apps: ["github"],
  variables: [
    {
      name: "owner",
      description:
        "The account owner of the repository. The name is not case sensitive.",
    },
    {
      name: "repo",
      description:
        "The name of the repository without the .git extension. The name is not case sensitive.",
    },
    "title",
    "body",
    "base",
    "head",
  ],
  run: async ({ auths, variables }) => {
    const github = new GitHub({
      auth: auths.github,
    });
    const response = await github.createPullRequest({
      owner: variables.owner!,
      repo: variables.repo!,
      title: variables.title!,
      body: variables.body!,
      base: variables.base!,
      head: variables.head!,
    });
    console.log("Response: ", response.data);
  },
});