Action: Create or Update File

GitHub Operation

This GitHub action creates a new file or updates an existing file in a repository.

Example User Story

I want to update the README file to include new installation instructions for the latest release.

Fields

Field Name	Field Type	Required
path	String	Yes
content	String	Yes
message	String	Yes
branch	String	No
sha	String	No

Related Connections

GitHub

Related Automations

Example link

Code (Apache v2.0): Operation

{
  "handle": "create-or-update-file",
  "state": "inDev",
  "meta": {
    "short": "Create or Update File",
    "description": "Creates a new file or updates an existing file in a GitHub repository."
  },
  "input": [
    {
      "name": "path",
      "type": "String",
      "required": true,
      "meta": {
        "description": "The path to the file in the repository."
      }
    },
    {
      "name": "content",
      "type": "String",
      "required": true,
      "meta": {
        "description": "The content of the file, Base64 encoded."
      }
    },
    {
      "name": "message",
      "type": "String",
      "required": true,
      "meta": {
        "description": "The commit message."
      }
    },
    {
      "name": "branch",
      "type": "String",
      "required": false,
      "meta": {
        "description": "The branch name. Defaults to the repository's default branch."
      }
    },
    {
      "name": "sha",
      "type": "String",
      "required": false,
      "meta": {
        "description": "The SHA of the file if updating an existing file."
      }
    }
  ],
  "output": [
    {
      "name": "commit",
      "type": "Object",
      "selector": [
        "commit"
      ],
      "meta": {
        "description": "The commit details."
      }
    },
    {
      "name": "content",
      "type": "Object",
      "selector": [
        "content"
      ],
      "meta": {
        "description": "The content details."
      }
    }
  ],
  "steps": [
    {
      "type": "http",
      "http": {
        "method": "PUT",
        "path": "/contents/{{path}}",
        "headers": {
          "Content-Type": "application/json"
        },
        "bodyTemplate": {
          "value": "{\"message\":\"{{message}}\",\"content\":\"{{content}}\",\"branch\":\"{{branch}}\",\"sha\":\"{{sha}}\"}",
          "placeholders": [
            {
              "name": "message",
              "type": "String",
              "description": "The commit message.",
              "required": true
            },
            {
              "name": "content",
              "type": "String",
              "description": "The file content, Base64 encoded.",
              "required": true
            },
            {
              "name": "branch",
              "type": "String",
              "description": "The branch name.",
              "required": false
            },
            {
              "name": "sha",
              "type": "String",
              "description": "The SHA of the file if updating.",
              "required": false
            }
          ]
        }
      }
    }
  ]
}