POST

Try POST /repos/{owner}/{repo}/releases/generate-notes — GitHub API

GitHub playground

Generate release notes content for a release

Credentials

GitHub token · sent as Authorization

Kept in this tab only. Requests go through apicheats.dev's same-origin proxy straight to api.github.com; the proxy stores and logs nothing about them.

Headers

Accept · fixedX-GitHub-Api-Version · fixed

Path

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.

Body application/json

4 body fields

tag_name · required · string — The tag name for the release. This can be an existing tag or a new one.
target_commitish · optional · string — 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_name · optional · string — 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_path · optional · string — 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.