Action: Create Branch

GitLab Operation

The Create Branch action creates a new branch in a repository.

Example User Story

I want to create a new feature branch so I can safely develop a checkout improvement without affecting the main codebase.

Fields

Field Name	Field Type	Required
projectId	Integer	Yes
branchName	String	Yes
ref	String	Yes

Related Connections

GitLab

Related Automations

Example link

Code (Apache v2.0): Operation

{
  "handle": "create-branch",
  "state": "inDev",
  "meta": {
    "short": "Create Branch",
    "description": "Creates a new branch in a GitLab repository."
  },
  "input": [
    {
      "name": "projectId",
      "type": "Integer",
      "required": true,
      "meta": {
        "description": "The ID of the GitLab project."
      }
    },
    {
      "name": "branchName",
      "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., another branch or a commit SHA)."
      }
    }
  ],
  "output": [
    {
      "name": "branch",
      "type": "Object",
      "selector": ["branch"],
      "meta": {
        "description": "The created branch details."
      }
    }
  ],
  "steps": [
    {
      "type": "http",
      "http": {
        "method": "POST",
        "path": "/api/v4/projects/{{projectId}}/repository/branches",
        "headers": {
          "Content-Type": "application/json",
          "PRIVATE-TOKEN": "{{.auth.token}}"
        },
        "bodyTemplate": {
          "value": "{\"branch\": \"{{branchName}}\", \"ref\": \"{{ref}}\"}",
          "placeholders": [
            {
              "name": "branchName",
              "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
            }
          ]
        }
      }
    }
  ]
}