POST /repos/{owner}/{repo}/releases
Users with push access to the repository can create a release.
[!NOTE] If the commit identified by
target_commitish(or, whentarget_commitishis omitted, the latest commit on the default branch) adds or modifies any file under.github/workflows/relative to the repository's default branch, the authenticating token must be authorized to modify workflows. Otherwise, this endpoint returns404 Not Found; some authentication paths surface403 Resource not accessible by integrationinstead.
OAuth app tokens and personal access tokens (classic) need the workflow scope when the resolved target commit modifies workflow files. Fine-grained access tokens and GitHub App installation tokens also need the "Workflows" repository permission (write). The GITHUB_TOKEN available to GitHub Actions cannot be authorized for this; for more information, see "Automatic token authentication".
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "Rate limits for the API" and "Best practices for using the REST API."
Servers
- https://api.github.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
repo |
String | Yes |
The name of the repository without the |
owner |
String | Yes |
The account owner of the repository. The name is not case sensitive. |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
target_commitish |
String | No |
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. |
draft |
Boolean | No |
Default value: false |
make_latest |
String | No |
Specifies whether this release should be set as the latest release for the repository. Drafts and prereleases cannot be set as latest. Defaults to Valid values:
Default value: "true" |
tag_name |
String | Yes |
The name of the tag. |
name |
String | No |
The name of the release. |
generate_release_notes |
Boolean | No |
Whether to automatically generate the name and body for this release. If Default value: false |
body |
String | No |
Text describing the contents of the tag. |
prerelease |
Boolean | No |
Default value: false |
discussion_category_name |
String | No |
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." |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.