GitHub: Generate release notes content for a release

← Repos operations · Get started

Operation github.repos_generate_release_notes

Provider route: POST /repos/{owner}/{repo}/releases/generate-notes. 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"]["reposGenerateReleaseNotes"]>[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.reposGenerateReleaseNotes(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_generate_release_notes(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
body	object	Required within parent
body.configuration_file_path	string	Optional	Specifies a path to a file in the repository containing configuration settings used for generating the release notes. If unspecified, the configuration file located in the repository at ‘.github/release.yml’ or ‘.github/release.yaml’ will be used. If that is not present, the default configuration will be used.
body.previous_tag_name	string	Optional	The name of the previous tag to use as the starting point for the release notes. Use to manually specify the range for the set of changes considered as part this release.
body.tag_name	string	Required within parent	The tag name for the release. This can be an existing tag or a new one.
body.target_commitish	string	Optional	Specifies the commitish value that will be the target for the release’s tag. Required if the supplied tag_name does not reference an existing tag. Ignored if the tag_name already exists.

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 Generate release notes content for a release — response body

Referenced models: Generate release notes content for a release — response body

Schemas

Generate release notes content for a release — response body

Field	Type	Presence	Description and constraints
$	object	Root	Generated name and body describing a release
body	string	Required within parent	The generated body describing the contents of the release supporting markdown formatting
name	string	Required within parent	The generated name of the release

Policy, approvals and errors

SDK function policy ID: github.repos_generate_release_notes. Catalog operation: repos/generate-release-notes. 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