Create GitHub pull request review comment

github.createPullRequestReviewComment creates a standalone inline comment on a pull request diff.

automations/comment-on-github-diff.automation.ts

import { automation } from "automate.ax"
import { github } from "automate.ax/github"

export default automation("Comment on GitHub diff", () => {
  github.createPullRequestReviewComment({
    body: "Please handle the empty response here.",
    commitId: "pull-request-head-sha",
    line: 48,
    owner: "SentsCo",
    path: "src/api.ts",
    pullRequestNumber: 42,
    repository: "automate.ax",
    side: "RIGHT",
  })
})

Provide the repository, pullRequestNumber, Markdown body, reviewed commitId, and file path. For an inline comment, omit subjectType or set it to "line", then provide line and side. For a multi-line comment, also provide startLine and startSide together. For a whole-file comment, set subjectType: "file" and omit all line fields. Diff coordinates must exist in the selected commit. Returns the comment’s id, body, and file path. Requires Pull requests write permission.

Built-in triggers

Built-in actions

Runtime utilities

Integrations

Create GitHub pull request review comment