Sample - GitHub REST API
POST/repos/{owner}/{repo}/releases/generate-notes

Generate release notes content for a release

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.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

2 parameters · 4 body fields
ownerstringrequired
The account owner of the repository. The name is not case sensitive.
repostringrequired
The name of the repository without the `.git` extension. The name is not case sensitive.
tag_namestringrequired
The tag name for the release. This can be an existing tag or a new one.
target_commitishstringoptional
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.
previous_tag_namestringoptional
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.
configuration_file_pathstringoptional
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.

2 status codes
200Name and body of generated release notes
namestringrequired
The generated name of the release
bodystringrequired
The generated body describing the contents of the release supporting markdown formatting
404Resource not found
messagestringoptional
documentation_urlstringoptional
urlstringoptional
statusstringoptional

Error handling

A 404 is returned: Resource not found.