Action: New Branch

GitHub Operation

This GitHub action creates a new branch in a repository.

Example User Story

I want to create a new branch for an experimental feature so I can test changes without disrupting the main development workflow.

Fields

Field Name	Field Type	Required
branch	String	Yes
ref	String	Yes

Related Connections

GitHub

Related Automations

Example link

Code (Apache v2.0): Operation

{
  "handle": "new-branch",
  "state": "inDev",
  "meta": {
    "short": "New Branch",
    "description": "Creates a new branch in a GitHub repository."
  },
  "input": [
    {
      "name": "branch",
      "type": "String",
      "required": true,
      "meta": {
        "description": "The name of the new branch."
      }
    },
    {
      "name": "ref",
      "type": "String",
      "required": true,
      "meta": {
        "description": "The reference to create the branch from (e.g., a commit SHA or another branch name)."
      }
    }
  ],
  "output": [
    {
      "name": "ref",
      "type": "String",
      "selector": [
        "ref"
      ],
      "meta": {
        "description": "The reference of the newly created branch."
      }
    },
    {
      "name": "object",
      "type": "Object",
      "selector": [
        "object"
      ],
      "meta": {
        "description": "The object of the newly created branch."
      }
    }
  ],
  "steps": [
    {
      "type": "http",
      "http": {
        "method": "POST",
        "path": "/git/refs",
        "headers": {
          "Content-Type": "application/json",
          "Accept": "application/vnd.github.v3+json"
        },
        "bodyTemplate": {
          "value": "{\"ref\":\"refs/heads/{{branch}}\",\"sha\":\"{{ref}}\"}",
          "placeholders": [
            {
              "name": "branch",
              "type": "String",
              "description": "The name of the new branch.",
              "required": true
            },
            {
              "name": "ref",
              "type": "String",
              "description": "The reference to create the branch from.",
              "required": true
            }
          ]
        }
      }
    }
  ]
}