---
title: "Generate release notes content for a release"
method: POST
path: "/repos/{owner}/{repo}/releases/generate-notes"
tags: ["repos"]
---

# Generate release notes content for a release

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

Generate a name and body describing a [release](https://docs.github.com/enterprise-cloud@latest/rest/releases/releases#get-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.

## Path parameters

- `owner` string, required
- `repo` string, required

## Request body

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

## Response `200`

Name and body of generated release notes

- ReleaseNotesContent — Generated name and body describing a release
  - `name` string, required — The generated name of the release
  - `body` string, required — The generated body describing the contents of the release supporting markdown formatting

## Other responses

- `404` — Resource not found

---

[API](https://skmtc.net/github/apis/github-v3-rest-api-3.md) · [All operations](https://skmtc.net/github/apis/github-v3-rest-api-3/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/github/github-v3-rest-api-3/versions/dc0584ac4e13/schema)