Action: Create Pull Request

GitHub Operation

This GitHub action creates a new pull request in a repository.

Example User Story

I want to create a pull request for my feature branch so the team can review and merge my changes.

Fields

Field Name	Field Type	Required
title	String	Yes
head	String	Yes
base	String	Yes
body	String	No

Related Connections

GitHub

Related Automations

Example link

Code (Apache v2.0): Operation

{
  "handle": "create-pull-request",
  "state": "inDev",
  "meta": {
    "short": "Create Pull Request",
    "description": "Creates a new pull request in a GitHub repository."
  },
  "input": [
    {
      "name": "title",
      "type": "String",
      "required": true,
      "meta": {
        "description": "The title of the pull request."
      }
    },
    {
      "name": "head",
      "type": "String",
      "required": true,
      "meta": {
        "description": "The name of the branch where your changes are implemented."
      }
    },
    {
      "name": "base",
      "type": "String",
      "required": true,
      "meta": {
        "description": "The name of the branch you want the changes pulled into."
      }
    },
    {
      "name": "body",
      "type": "String",
      "required": false,
      "meta": {
        "description": "The body content of the pull request."
      }
    }
  ],
  "output": [
    {
      "name": "number",
      "type": "Integer",
      "selector": [
        "number"
      ],
      "meta": {
        "description": "The pull request number."
      }
    },
    {
      "name": "url",
      "type": "String",
      "selector": [
        "html_url"
      ],
      "meta": {
        "description": "The URL of the pull request."
      }
    }
  ],
  "steps": [
    {
      "type": "http",
      "http": {
        "method": "POST",
        "path": "/pulls",
        "headers": {
          "Content-Type": "application/json",
          "Accept": "application/vnd.github+json"
        },
        "bodyTemplate": {
          "value": "{\"title\":\"{{title}}\",\"head\":\"{{head}}\",\"base\":\"{{base}}\",\"body\":\"{{body}}\"}",
          "placeholders": [
            {
              "name": "title",
              "type": "String",
              "description": "The title of the pull request.",
              "required": true
            },
            {
              "name": "head",
              "type": "String",
              "description": "The name of the branch where your changes are implemented.",
              "required": true
            },
            {
              "name": "base",
              "type": "String",
              "description": "The name of the branch you want the changes pulled into.",
              "required": true
            },
            {
              "name": "body",
              "type": "String",
              "description": "The body content of the pull request.",
              "required": false
            }
          ]
        }
      }
    }
  ]
}