Skip to content

Allow specifying release notes in PR descriptions directly #2727

@premun

Description

@premun

Problem

There are various cases when it's either not possible or not suitable to put release notes in issue and PR description is a better fit.

Some examples:

  • An issue consists of several steps - each step might be part of a different rollout and each step is a feature on its own (e.g. we found out part of a request is easier to do, while the other will take time and will be completed later).
  • Issue is logged by 3rd party or in a 3rd party repo - it's wrong to go and put release notes in somebody else's issues, even more so, when those are more high-level and require PRs in several repositories.
  • We are fixing a typo in a repo - there might not be an issue.

All the examples above could be dealt with by creating an artificial issue which would hold no information that is not already in the PR. This creates a lot of noise and lifts the barrier for small changes like the last example. The noise means that when we later search closed issues for investigations, there are too many extraneous results which hold no value.

Proposal

Also allow release notes in PR descriptions. This doesn't break the release note assembly process as that's a manual work done by vendors who will get the same experience as they will see the release notes in the PR directly. One less click for them.

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type
No fields configured for issues without a type.

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions