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

Proposal: notable-changes bot comment for summaries #821

Closed
BethGriggs opened this issue Feb 3, 2023 · 3 comments · Fixed by nodejs/node#47078
Closed

Proposal: notable-changes bot comment for summaries #821

BethGriggs opened this issue Feb 3, 2023 · 3 comments · Fixed by nodejs/node#47078

Comments

@BethGriggs
Copy link
Member

Something I've been thinking about for a while is extending the bot to add a comment whenever the notable changes label is added to a PR in nodejs/node. I haven't tried crafting it, but I'm assuming it'd be possible to implement.

The comment would say something like:

The notable-changes label has been added by _@user.

Please include your text below if you'd like to include a more detailed summary in the changelog.

[Insert here]

Why?

  • Releasers don't always have the context to expand on the notable changes - the author(s) are best placed to write these and determine if more detail is warranted.
  • Having the notable changes proposed in the PR rather than the release proposal means the text will be consistent between release lines by default.
  • Potential to extend our release preparation tooling to automatically pick-up the supplied text.

Proposing this here first to see if @nodejs/release thinks it's a good idea. We'll likely need to propose it more widely.

@targos
Copy link
Member

targos commented Feb 4, 2023

I think it's a very good idea!

@RafaelGSS
Copy link
Member

strong +1

@mhdawson
Copy link
Member

mhdawson commented Feb 7, 2023

+1 from me, sounds like a good idea :)

RafaelGSS pushed a commit to nodejs/node that referenced this issue Apr 5, 2023
PR-URL: #47078
Fixes: nodejs/Release#821
Reviewed-By: Beth Griggs <bethanyngriggs@gmail.com>
Reviewed-By: Moshe Atlow <moshe@atlow.co.il>
Reviewed-By: Tierney Cyren <hello@bnb.im>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
RafaelGSS pushed a commit to nodejs/node that referenced this issue Apr 7, 2023
PR-URL: #47078
Fixes: nodejs/Release#821
Reviewed-By: Beth Griggs <bethanyngriggs@gmail.com>
Reviewed-By: Moshe Atlow <moshe@atlow.co.il>
Reviewed-By: Tierney Cyren <hello@bnb.im>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
danielleadams added a commit to nodejs/node that referenced this issue Jul 6, 2023
PR-URL: #47078
Fixes: nodejs/Release#821
Reviewed-By: Beth Griggs <bethanyngriggs@gmail.com>
Reviewed-By: Moshe Atlow <moshe@atlow.co.il>
Reviewed-By: Tierney Cyren <hello@bnb.im>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants