GitHub: Create a release

← Repos operations · Get started

Operation github.repos_create_release

Provider route: POST /repos/{owner}/{repo}/releases. 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"]["reposCreateRelease"]>[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.reposCreateRelease(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_release(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.body	string	Optional	Text describing the contents of the tag.
body.discussion_category_name	string	Optional	If specified, a discussion of the specified category is created and linked to the release. The value must be a category that already exists in the repository. For more information, see “[Managing categories for discussions in your repository](https://docs.github.com/discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository).”
body.draft	boolean	Optional	`true` to create a draft (unpublished) release, `false` to create a published one. Default: false
body.generate_release_notes	boolean	Optional	Whether to automatically generate the name and body for this release. If `name` is specified, the specified name will be used; otherwise, a name will be automatically generated. If `body` is specified, the body will be pre-pended to the automatically generated notes. Default: false
body.make_latest	string	Optional	Specifies whether this release should be set as the latest release for the repository. Drafts and prereleases cannot be set as latest. Defaults to `true` for newly published releases. `legacy` specifies that the latest release should be determined based on the release creation date and higher semantic version. Default: true One of: true, false, legacy
body.name	string	Optional	The name of the release.
body.prerelease	boolean	Optional	`true` to identify the release as a prerelease. `false` to identify the release as a full release. Default: false
body.tag_name	string	Required within parent	The name of the tag.
body.target_commitish	string	Optional	Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository’s default branch.

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 release — response body

Referenced models: Get a release — response body

Schemas

2 more schemas are linked from the tables above, on the schema pages.

Get a release — response body

Field	Type	Presence	Description and constraints
$	object	Root	A release.
assets	array	Required within parent
assets[]	Model	Each item	Expand Get a release asset — response body
assets_url	string	Required within parent	Format: uri
author	Model	Required within parent	Expand List users — response body — item
body	JSON	Optional
body (anyOf 1)	string	Alternative
body (anyOf 2)	null	Alternative
body_html	string	Optional
body_text	string	Optional
created_at	string	Required within parent	Format: date-time
discussion_url	string	Optional	The URL of the release discussion. Format: uri
draft	boolean	Required within parent	true to create a draft (unpublished) release, false to create a published one.
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]+)?$
immutable	boolean	Optional	Whether or not the release is immutable.
mentions_count	JSON	Optional
mentions_count (anyOf 1)	integer	Alternative
mentions_count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
name	JSON	Required within parent
name (anyOf 1)	string	Alternative
name (anyOf 2)	null	Alternative
node_id	string	Required within parent
prerelease	boolean	Required within parent	Whether to identify the release as a prerelease or a full release.
published_at	JSON	Required within parent
published_at (anyOf 1)	string	Alternative	Format: date-time
published_at (anyOf 2)	null	Alternative
reactions	Model	Optional	Expand Get an issue — response body — reactions
tag_name	string	Required within parent	The name of the tag.
tarball_url	JSON	Required within parent
tarball_url (anyOf 1)	string	Alternative	Format: uri
tarball_url (anyOf 2)	null	Alternative
target_commitish	string	Required within parent	Specifies the commitish value that determines where the Git tag is created from.
updated_at	JSON	Optional
updated_at (anyOf 1)	string	Alternative	Format: date-time
updated_at (anyOf 2)	null	Alternative
upload_url	string	Required within parent
url	string	Required within parent	Format: uri
zipball_url	JSON	Required within parent
zipball_url (anyOf 1)	string	Alternative	Format: uri
zipball_url (anyOf 2)	null	Alternative

Referenced models: Get an issue — response body — reactions, Get a release asset — response body, List users — response body — item

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 a release asset — response body

Field	Type	Presence	Description and constraints
$	object	Root	Data related to a release.
browser_download_url	string	Required within parent	Format: uri
content_type	string	Required within parent
created_at	string	Required within parent	Format: date-time
digest	JSON	Required within parent
digest (anyOf 1)	string	Alternative
digest (anyOf 2)	null	Alternative
download_count	JSON	Required within parent
download_count (anyOf 1)	integer	Alternative
download_count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
id	JSON	Required within parent
id (anyOf 1)	integer	Alternative
id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
label	JSON	Required within parent
label (anyOf 1)	string	Alternative
label (anyOf 2)	null	Alternative
name	string	Required within parent	The file name of the asset.
node_id	string	Required within parent
size	JSON	Required within parent
size (anyOf 1)	integer	Alternative
size (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
state	string	Required within parent	State of the release asset. Known values: uploaded, open
updated_at	string	Required within parent	Format: date-time
uploader	Model	Required within parent	Expand Get an issue — response body — user
url	string	Required within parent	Format: uri

Referenced models: Get an issue — response body — user

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

Policy, approvals and errors

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