Skip to content
forgit api docs

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.

API method documentation

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “ Path Parameters ”
owner
required
string

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

repo
required
string

The name of the repository without the .git extension. The name is not case sensitive.

Request Body required

Section titled “ Request Body required ”
Media type application/json
object
tag_name
required

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

string
target_commitish

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.

string
previous_tag_name

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.

string
configuration_file_path

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.

string
Examples
Example default 
{
  "tag_name": "v1.0.0",
  "target_commitish": "main",
  "previous_tag_name": "v0.9.2",
  "configuration_file_path": ".github/custom_release_config.yml"
}

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

Name and body of generated release notes

Media type application/json
Generated Release Notes Content

Generated name and body describing a release

object
name
required

The generated name of the release

string
body
required

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

string
Examples
Example default 
{
  "name": "Release v1.0.0 is now available!",
  "body": "##Changes in Release v1.0.0 ... ##Contributors @monalisa"
}

404

Section titled “ 404 ”

Resource not found

Media type application/json
Basic Error

Basic Error

object
message
string
documentation_url
string
url
string
status
string
Example generated 
{
  "message": "example",
  "documentation_url": "example",
  "url": "example",
  "status": "example"
}