GitHub: Create a commit comment

GitHub repos.reposCreateCommitComment: arguments, response, policy and SDK examples.

Operation github.repos_create_commit_comment

Provider route: POST /repos/{owner}/{repo}/commits/{commit_sha}/comments. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/github with npm, or alter-sdk-github with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { GitHubIntegration } from "@alter-ai/github";

async function execute(input: Parameters<GitHubIntegration["repos"]["reposCreateCommitComment"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new GitHubIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.repos.reposCreateCommitComment(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_github import GitHubIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = GitHubIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.repos.repos_create_commit_comment(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
`$`	object	Root	Additional keys: not allowed
`path`	object	Required within parent	Additional keys: not allowed
`path.owner`	string	Required within parent
`path.repo`	string	Required within parent
`path.commit_sha`	string	Required within parent
`body`	object	Required within parent
`body.body`	string	Required within parent	The contents of the comment.
`body.line`	integer	Optional	Closing down notice. Use position parameter instead. Line number in the file to comment on.
`body.path`	string	Optional	Relative path of the file to comment on.
`body.position`	integer	Optional	Line index in the diff to comment on.

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
`$`	Model	Root	Expand Get a commit comment — response body

Referenced models: Get a commit comment — response body

Schemas

Get a commit comment — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	Commit Comment
`author_association`	string	Required within parent	How the author is associated with the repository. Known values: COLLABORATOR, CONTRIBUTOR, FIRST_TIMER, FIRST_TIME_CONTRIBUTOR, MANNEQUIN, MEMBER, NONE, OWNER
`body`	string	Required within parent
`commit_id`	string	Required within parent
`created_at`	string	Required within parent	Format: date-time
`html_url`	string	Required within parent	Format: uri
`id`	JSON	Required within parent
`id (anyOf 1)`	integer	Alternative
`id (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`line`	JSON	Required within parent
`line (anyOf 1)`	JSON	Alternative
`line (anyOf 1) (anyOf 1)`	integer	Alternative
`line (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`line (anyOf 2)`	null	Alternative
`node_id`	string	Required within parent
`path`	JSON	Required within parent
`path (anyOf 1)`	string	Alternative
`path (anyOf 2)`	null	Alternative
`position`	JSON	Required within parent
`position (anyOf 1)`	JSON	Alternative
`position (anyOf 1) (anyOf 1)`	integer	Alternative
`position (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`position (anyOf 2)`	null	Alternative
`reactions`	Model	Optional	Expand Get an issue — response body — reactions
`updated_at`	string	Required within parent	Format: date-time
`url`	string	Required within parent	Format: uri
`user`	Model	Required within parent	Expand Get an issue — response body — user

Referenced models: Get an issue — response body — user, Get an issue — response body — reactions

Get an issue — response body — user

Field	Type	Presence	Description and constraints
`$`	JSON	Root
`$ (anyOf 1)`	Model	Alternative	Expand Get an issue — response body — user A Git Hub user
`$ (anyOf 2)`	null	Alternative

Referenced models: Get an issue — response body — user A Git Hub user

Get an issue — response body — reactions

Field	Type	Presence	Description and constraints
`$`	object	Root
`+1`	JSON	Required within parent
`+1 (anyOf 1)`	integer	Alternative
`+1 (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`-1`	JSON	Required within parent
`-1 (anyOf 1)`	integer	Alternative
`-1 (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`confused`	JSON	Required within parent
`confused (anyOf 1)`	integer	Alternative
`confused (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`eyes`	JSON	Required within parent
`eyes (anyOf 1)`	integer	Alternative
`eyes (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`heart`	JSON	Required within parent
`heart (anyOf 1)`	integer	Alternative
`heart (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`hooray`	JSON	Required within parent
`hooray (anyOf 1)`	integer	Alternative
`hooray (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`laugh`	JSON	Required within parent
`laugh (anyOf 1)`	integer	Alternative
`laugh (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`rocket`	JSON	Required within parent
`rocket (anyOf 1)`	integer	Alternative
`rocket (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`total_count`	JSON	Required within parent
`total_count (anyOf 1)`	integer	Alternative
`total_count (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`url`	string	Required within parent	Format: uri

Get an issue — response body — user A Git Hub user

Field	Type	Presence	Description and constraints
`$`	object	Root	A GitHub user.
`avatar_url`	string	Required within parent	Format: uri
`email`	JSON	Optional
`email (anyOf 1)`	string	Alternative
`email (anyOf 2)`	null	Alternative
`events_url`	string	Required within parent
`followers_url`	string	Required within parent	Format: uri
`following_url`	string	Required within parent
`gists_url`	string	Required within parent
`gravatar_id`	JSON	Required within parent
`gravatar_id (anyOf 1)`	string	Alternative
`gravatar_id (anyOf 2)`	null	Alternative
`html_url`	string	Required within parent	Format: uri
`id`	JSON	Required within parent
`id (anyOf 1)`	integer	Alternative	Format: int64
`id (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`login`	string	Required within parent
`name`	JSON	Optional
`name (anyOf 1)`	string	Alternative
`name (anyOf 2)`	null	Alternative
`node_id`	string	Required within parent
`organizations_url`	string	Required within parent	Format: uri
`received_events_url`	string	Required within parent	Format: uri
`repos_url`	string	Required within parent	Format: uri
`site_admin`	boolean	Required within parent
`starred_at`	string	Optional
`starred_url`	string	Required within parent
`subscriptions_url`	string	Required within parent	Format: uri
`type`	string	Required within parent
`url`	string	Required within parent	Format: uri
`user_view_type`	string	Optional

Policy, approvals and errors

SDK function policy ID: github.repos_create_commit_comment. Catalog operation: repos/create-commit-comment. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Pinned headers: {"X-GitHub-Api-Version": "2026-03-10", "User-Agent": "Alter", "Accept": "application/vnd.github+json"}

Official provider source

Report an issue with this page