releases_generate_notes - Charter Docs

POST

github_releases_generate_notes.py

import asyncio

from charter.packs import github

result = asyncio.run(github.releases_generate_notes.ainvoke({"owner": ..., "repo": ..., "tagName": ...}))

Requires repo. With github.APP or github.FINE_GRAINED, requires contents=write.

Path parameters

Field	Type	Description
`owner` *	`string`	The account owner of the repository. The name is not case sensitive.
`repo` *	`string`	The name of the repository without the `.git` extension. The name is not case sensitive.

Body

Field	Type	Description
`tagName` *	`string`	The tag name for the release. This can be an existing tag or a new one.
`targetCommitish`	`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.
`previousTagName`	`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 of this release.
`configurationFilePath`	`string`	Specifies a path to a file in the repository containing configuration settings used for generating the release notes. Absent, GitHub uses `.github/release.yml` or `.github/release.yaml` if either exists.