Skip to content

Include PRs without notes:ready in generated release notes #1202

@ysthakur

Description

@ysthakur

Right now, when generating a release notes PR, if an included PR isn't labelled with notes:ready, we don't include the release notes at all. This means that for such PRs, the person writing the release notes has to manually copy the release notes from that PR.

I believe that most of the time, the absence of the notes:ready label just means that the PR author forgot to add the label. In any case, I think it's best if we included the PR's "Release Notes Summary" section in the generated release notes anyway. If the person writing the release notes doesn't like it, they can easily delete it.

This is the bit we need to touch. Easy peasy

mut notes = if "## Release notes summary" in $pr.body {
$pr.body | extract-notes
} else if $has_ready_label {
# If no release notes summary exists but ready label is set, treat as empty
$pr = $pr | add-notice warning "no release notes section but notes:ready label"
""

Metadata

Metadata

Assignees

Labels

enhancementNew feature or request

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions