Action: Create Comment

GitHub Operation

This GitHub action posts a new comment on an issue or pull request.

Example User Story

I want to add a comment to a pull request to request changes before merging the code.

Fields

Field Name	Field Type	Required
issueNumber	Integer	Yes
body	String	Yes

Related Connections

GitHub

Related Automations

Example link

Code (Apache v2.0): Operation

{
  "handle": "create-comment",
  "state": "inDev",
  "meta": {
    "short": "Create Comment",
    "description": "Creates a comment on a GitHub issue or pull request."
  },
  "input": [
    {
      "name": "issueNumber",
      "type": "Integer",
      "required": true,
      "meta": {
        "description": "The issue or pull request number."
      }
    },
    {
      "name": "body",
      "type": "String",
      "required": true,
      "meta": {
        "description": "The content of the comment."
      }
    }
  ],
  "output": [
    {
      "name": "comment",
      "type": "Object",
      "selector": [
        "body"
      ],
      "meta": {
        "description": "The created comment object."
      }
    }
  ],
  "steps": [
    {
      "type": "http",
      "http": {
        "method": "POST",
        "path": "/issues/{{issueNumber}}/comments",
        "headers": {
          "Content-Type": "application/json",
          "Accept": "application/vnd.github.v3+json"
        },
        "bodyTemplate": {
          "value": "{\"body\": \"{{body}}\"}",
          "placeholders": [
            {
              "name": "body",
              "type": "String",
              "description": "The content of the comment.",
              "required": true
            }
          ]
        }
      }
    }
  ]
}