Generate release notes content for a release

POST

/repos/{owner}/{repo}/releases/generate-notes

Generate a name and body describing a release. The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.github.com/repos///releases/generate-notes' \
--header 'Content-Type: application/json' \
--data-raw '{
    "configuration_file_path": ".github/custom_release_config.yml",
    "previous_tag_name": "v0.9.2",
    "tag_name": "v1.0.0",
    "target_commitish": "main"
}'

Response Example

200 - Example 1

{
    "body": "string",
    "name": "Release v1.0.0 is now available!"
}

Request

Path Params

owner

string

required

The account owner of the repository. The name is not case sensitive.

repo

string

required

The name of the repository. The name is not case sensitive.

Body Params application/json

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.

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.

tag_name

string

required

The tag name for the release. This can be an existing tag or a new one.

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.

Examples

Responses

🟢200Name and body of generated release notes

application/json

Body

Generated name and body describing a release

body

string

required

The generated body describing the contents of the release supporting markdown formatting

name

string

required

The generated name of the release

Example:

Release v1.0.0 is now available!

🟠404404

Modified at 2023-08-15 02:59:24

Update a release asset

Get the latest release