Action: Delete Branch

GitHub Operation

This GitHub action deletes an existing branch from a repository.

Example User Story

I want to delete the stale feature branch after merging to keep the repository clean and organized.

Fields

Field Name	Field Type	Required
branch	String	Yes

Related Connections

GitHub

Related Automations

Example link

Code (Apache v2.0): Operation

{
  "handle": "delete-branch",
  "state": "inDev",
  "meta": {
    "short": "Delete Branch",
    "description": "Deletes a branch from a GitHub repository."
  },
  "input": [
    {
      "name": "branch",
      "type": "String",
      "required": true,
      "meta": {
        "description": "The name of the branch to delete."
      }
    }
  ],
  "output": [
    {
      "name": "status",
      "type": "String",
      "selector": [
        "status"
      ],
      "meta": {
        "description": "The status of the deletion request."
      }
    }
  ],
  "steps": [
    {
      "type": "http",
      "http": {
        "method": "DELETE",
        "path": "/git/refs/heads/{{branch}}",
        "headers": {
          "Accept": "application/vnd.github.v3+json"
        }
      }
    }
  ]
}