Skip to content

[enhancement]: GitHubRelease@1 should have option to auto generate release notes #20759

Open
@VictorIreri

Description

@VictorIreri

Task name

GitHubRelease@1

Describe your feature request here

The GitHub API provides a generate_release_notes parameter but the GitHubRelease@1 task does not provide this functionality.
Image

Currently, release notes are provided via the inputs releaseNotesSource (with value filePath or inline) and either releaseNotesFilePath or releaseNotesInline. Perhaps the releaseNotesSource input could support an additional value auto, which would provide the new functionality without breaking existing setups.

I also tried using changeLogType: issueBased, which is the task's own implementation of automatically generating release notes but faced issues. The docs state it would list all the issues or pull requests included in the release however, I got the error below presumably because the logic in Changelog.ts doesn't account for commits with Azure work item number formatting such as AB#1011069 and so it tried to find GitHub Issue/PR #1011069, which doesn't exist.

Error fetching issues. Cannot generate change log.
##[warning][{"type":"NOT_FOUND","path":["repository","_1011069"],"locations":[{"line":3,"column":193}],
"message":"Could not resolve to an issue or pull request with the number of 1011069."}]

So I'm suggesting the option to use GitHub's logic instead.
FYI, automatic release note generation is also available in GitHub CLI and GitHub's UI.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions