reposGenerateReleaseNotes
Generate release notes content for a release
Details
- Method:
POST - Path:
/repos/{owner}/{repo}/releases/generate-notes - Operation ID:
repos/generate-release-notes
Parameters
{
"owner": {
"description": "The account owner of the repository. The name is not case sensitive.",
"required": true,
"location": "path",
"type": "string"
},
"repo": {
"description": "The name of the repository without the `.git` extension. The name is not case sensitive.",
"required": true,
"location": "path",
"type": "string"
},
"tag_name": {
"description": "The tag name for the release. This can be an existing tag or a new one.",
"required": true,
"location": "body",
"type": "string"
},
"target_commitish": {
"description": "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.",
"required": false,
"location": "body",
"type": "string"
},
"previous_tag_name": {
"description": "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.",
"required": false,
"location": "body",
"type": "string"
},
"configuration_file_path": {
"description": "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.",
"required": false,
"location": "body",
"type": "string"
}
}Response Schema
{
"title": "Generated Release Notes Content",
"description": "Generated name and body describing a release",
"type": "object",
"properties": {
"name": {
"description": "The generated name of the release",
"type": "string",
"example": "Release v1.0.0 is now available!"
},
"body": {
"description": "The generated body describing the contents of the release supporting markdown formatting",
"type": "string"
}
},
"required": [
"name",
"body"
]
}Usage
from ocp_agent import OCPAgent
agent = OCPAgent()
await agent.register_api('github')
# Call this tool
result = await agent.call_tool('reposGenerateReleaseNotes', {
# Add required parameters here
})