Create a release
Create a new release for a repository. The authenticated user must have create permissions.
Path Parameters
- repo string required
The name of the repository. The name is not case sensitive.
- application/json
Request Body
- tag string required
Name of the tag.
- name string
Name of the release.
- description string
Description of the release.
- draft boolean
Default value:
false
true to create a draft (unpublished) release, false to create a published one.
- prerelease boolean
Default value:
false
true to identify the release as a prerelease, false to identify the release as a full release.
- make_latest boolean
Default value:
true
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.
- 200
- 409
Successful Response
- application/json
- Schema
- Example (from schema)
Schema
- success boolean required
data object required
tag string requiredRelease tag
name string requiredRelease name
description string requiredRelease description
created_at date-time requiredCreation date
updated_at date-time requiredUpdated date
draft boolean requiredtrue for unpublished releases
prerelease boolean requiredtrue for prerelease releases
assets string[] required
{
"success": true,
"data": {
"tag": "v1.0.0",
"name": "v1.0.0",
"description": "An example release.",
"created_at": "2023-02-26T21:24:33.044Z",
"updated_at": "2023-02-26T21:24:33.044Z",
"draft": false,
"prerelease": false,
"assets": [
"build.zip"
]
}
}
Successful Response
- application/json
- Schema
- Example (from schema)
Schema
- success boolean required
- error string required
{
"success": false,
"error": "repository already exists"
}