Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merging multiple PRs into a single release note is unintuitive and clunky #1354

Open
alice-i-cecile opened this issue Jun 4, 2024 · 3 comments · May be fixed by #1650
Open

Merging multiple PRs into a single release note is unintuitive and clunky #1354

alice-i-cecile opened this issue Jun 4, 2024 · 3 comments · May be fixed by #1650
Assignees
Labels
A-Release-Notes C-Automation Tools to make repetitive tasks easier C-Usability
Milestone

Comments

@alice-i-cecile
Copy link
Member

alice-i-cecile commented Jun 4, 2024

Many large features (or areas of related work) end up being done over multiple distinct PRs. When triaging, it's not uncommon for multiple of them to get the S-Needs-Release-Note label. However in the final document, we want to group them under a single heading.

If we simply delete one of the entries, rerunning the tool to catch new updates will add back the old merged PRs!

The current workflow is:

  1. Delete the file and entry used for the PR(s) you're merging in.
  2. Remove the entry from the _release-notes.toml file.
  3. Edit the file for the PRs you're reusing (without changing the file name)
  4. Remove the S-Needs-Release-Note label from the PR(s) that have been merged in so they don't get regenerated
@alice-i-cecile
Copy link
Member Author

I think the best way to do this is to add a set of PR numbers to the metadata for each release note entry, explaining which PR they cover. I expect this work could be nicely tackled alongside #1350, as they both touch on the question of 'when should we regenerate notes".

@alice-i-cecile alice-i-cecile added C-Automation Tools to make repetitive tasks easier and removed A-Build-System labels Jun 5, 2024
@alice-i-cecile alice-i-cecile added this to the Release v0.15 milestone Oct 13, 2024
@TrialDragon
Copy link
Member

Presuming no one else who has more time wants to tackle this, I'll work on this.

@TrialDragon TrialDragon self-assigned this Oct 14, 2024
@alice-i-cecile
Copy link
Member Author

That would be incredibly valuable. Let me know if I can do anything to support you in this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-Release-Notes C-Automation Tools to make repetitive tasks easier C-Usability
Projects
None yet
2 participants