meta: automate description requests when notable change label is added #47078

danielleadams · 2023-03-14T02:23:54Z

Adds a GH hook to leave a comment to ask for "Notable Change" descriptions.

Fixes: nodejs/Release#821

nodejs-github-bot · 2023-03-14T02:23:58Z

Review requested:

@nodejs/actions

BethGriggs

LGTM, but unsure on how we can test it before landing.

MoLow · 2023-03-15T19:00:58Z

LGTM, but unsure on how we can test it before landing.

that is what https://github.com/nodejs/node-auto-test is for

mhdawson · 2023-03-15T20:06:34Z

I think new actions will not run on a PR as otherwise that would be an attack vector where anybody who submitted a PR could get us to run things. I think past best practice has been do do whatever testing you can in a personal repo and then land the PR and tweak through follow on PRs as necessary.

danielleadams · 2023-03-16T12:54:18Z

I'm testing it on my fork and will report back

danielleadams · 2023-03-16T13:04:36Z

Tested here: danielleadams#3 ✅

panva

I am not sure what the intended action item is based on the message. Is it to post a new comment or to edit the one made by the bot?

bnb · 2023-03-16T13:13:46Z

.github/workflows/comment-labeled.yml

+      - name: Add notable change description
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: gh pr comment ${{ github.event.pull_request.number }} --repo ${{ github.repository }} --body "$NOTABLE_CHANGE_MESSAGE"


using gh pr comment like this is such a good idea. First time I've seen it, this is awesome.

danielleadams · 2023-03-16T13:15:50Z

I am not sure what the intended action item is based on the message. Is it to post a new comment or to edit the one made by the bot?

@panva you can do either. See nodejs/Release#821 - the change is to have better descriptions of notable changes so that the release notes are more consistent across release lines (and developers get better overall release notes), so how it's communicated is up to the PR author.

panva · 2023-03-16T13:17:42Z

I am not sure what the intended action item is based on the message. Is it to post a new comment or to edit the one made by the bot?

@panva you can do either. See nodejs/Release#821 - the change is to have better descriptions of notable changes so that the release notes are more consistent across release lines (and developers get better overall release notes), so how it's communicated is up to the PR author.

Let's come up with a better copy then, one that works for both collaborators who can edit the bot's comment and contributors who don't. I'll try to jot something down later today.

panva · 2023-03-16T13:39:33Z

.github/workflows/comment-labeled.yml

+    The notable-changes label has been added by @${{ github.actor }}.
+    Please include your text below if you'd like to include a more detailed summary in the changelog.
+    ```
+    [Insert here]
+    ```


Suggested change

The notable-changes label has been added by @${{ github.actor }}.

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

```

[Insert here]

```

The ${{ github.event.label.url }} label has been added by @${{ github.actor }}.

Please suggest a text for the release notes if you'd like to include a more detailed summary, then proceed to update the PR description with the text or a link to the notable change suggested text comment.

Something along these lines. Feel free to play around with it.

The link will make the label appear like so notable-change PRs with changes that should be highlighted in changelogs.

@panva when I opened the PR, the event provided a different url (danielleadams#4 (comment)), so going to replace with the hard coded link.

nodejs-github-bot · 2023-03-24T05:27:18Z

Landed in d612613

panva · 2023-03-29T15:48:40Z

#47078 (comment)

I don't think this was reflected...

panva · 2023-03-29T15:49:29Z

(testing, altho actions has degraded performance at this time so might take a while for the comment to appear, i'll keep tabs on this and follow up)

github-actions · 2023-03-29T17:42:39Z

The https://api.github.com/repos/nodejs/node/labels/notable-change label has been added by @panva.

Please suggest a text for the release notes if you'd like to include a more detailed summary, then proceed to update the PR description with the text or a link to the notable change suggested text comment.

panva · 2023-03-29T17:46:26Z

#47300

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 the notable-change PRs with changes that should be highlighted in changelogs. label Mar 14, 2023

nodejs-github-bot added the meta Issues and PRs related to the general management of the project. label Mar 14, 2023

danielleadams removed the notable-change PRs with changes that should be highlighted in changelogs. label Mar 14, 2023

danielleadams marked this pull request as ready for review March 14, 2023 02:24

danielleadams added the notable-change PRs with changes that should be highlighted in changelogs. label Mar 14, 2023

danielleadams closed this Mar 14, 2023

danielleadams deleted the notable-change-bot branch March 15, 2023 11:42

danielleadams restored the notable-change-bot branch March 15, 2023 17:44

danielleadams reopened this Mar 15, 2023

danielleadams marked this pull request as draft March 15, 2023 17:45

danielleadams marked this pull request as ready for review March 15, 2023 17:46

danielleadams force-pushed the notable-change-bot branch from bc3692a to d2123c7 Compare March 15, 2023 17:53

danielleadams removed the notable-change PRs with changes that should be highlighted in changelogs. label Mar 15, 2023

BethGriggs approved these changes Mar 15, 2023

View reviewed changes

MoLow approved these changes Mar 15, 2023

View reviewed changes

danielleadams changed the title ~~chore: automate description requests when notable change label is added~~ meta: automate description requests when notable change label is added Mar 15, 2023

danielleadams force-pushed the notable-change-bot branch from d2123c7 to 7723749 Compare March 16, 2023 13:05

bnb approved these changes Mar 16, 2023

View reviewed changes

danielleadams force-pushed the notable-change-bot branch from 7723749 to 736c7fa Compare March 16, 2023 13:10

panva reviewed Mar 16, 2023

View reviewed changes

bnb reviewed Mar 16, 2023

View reviewed changes

panva reviewed Mar 16, 2023

View reviewed changes

danielleadams force-pushed the notable-change-bot branch from 736c7fa to 01d6451 Compare March 19, 2023 00:27

meta: automate description requests when notable change label is added

49f3a32

danielleadams force-pushed the notable-change-bot branch from 01d6451 to 49f3a32 Compare March 19, 2023 00:42

targos approved these changes Mar 22, 2023

View reviewed changes

Trott approved these changes Mar 24, 2023

View reviewed changes

Trott added the commit-queue Add this label to land a pull request using GitHub Actions. label Mar 24, 2023

nodejs-github-bot removed the commit-queue Add this label to land a pull request using GitHub Actions. label Mar 24, 2023

nodejs-github-bot merged commit d612613 into nodejs:main Mar 24, 2023
13 checks passed

panva added the notable-change PRs with changes that should be highlighted in changelogs. label Mar 29, 2023

panva added notable-change PRs with changes that should be highlighted in changelogs. and removed notable-change PRs with changes that should be highlighted in changelogs. labels Mar 29, 2023

panva removed the notable-change PRs with changes that should be highlighted in changelogs. label Mar 29, 2023

panva mentioned this pull request Mar 29, 2023

meta: fix notable-change comment label url #47300

Merged

RafaelGSS mentioned this pull request Apr 3, 2023

2023-04-18, Version 20.0.0 (Current) #47381

Merged

RafaelGSS mentioned this pull request Apr 6, 2023

v19.9.0 proposal #47441

Merged

danielleadams mentioned this pull request Jul 10, 2023

v18.17.0 release proposal #48694

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

meta: automate description requests when notable change label is added #47078

meta: automate description requests when notable change label is added #47078

danielleadams commented Mar 14, 2023 •

edited

nodejs-github-bot commented Mar 14, 2023

BethGriggs left a comment

MoLow commented Mar 15, 2023

mhdawson commented Mar 15, 2023

danielleadams commented Mar 16, 2023

danielleadams commented Mar 16, 2023 •

edited

panva left a comment

bnb Mar 16, 2023 •

edited

danielleadams commented Mar 16, 2023

panva commented Mar 16, 2023

panva Mar 16, 2023 •

edited

panva Mar 16, 2023

danielleadams Mar 19, 2023

panva Mar 19, 2023

nodejs-github-bot commented Mar 24, 2023

panva commented Mar 29, 2023

panva commented Mar 29, 2023 •

edited

github-actions bot commented Mar 29, 2023

panva commented Mar 29, 2023

meta: automate description requests when notable change label is added #47078

meta: automate description requests when notable change label is added #47078

Conversation

danielleadams commented Mar 14, 2023 • edited

nodejs-github-bot commented Mar 14, 2023

BethGriggs left a comment

Choose a reason for hiding this comment

MoLow commented Mar 15, 2023

mhdawson commented Mar 15, 2023

danielleadams commented Mar 16, 2023

danielleadams commented Mar 16, 2023 • edited

panva left a comment

Choose a reason for hiding this comment

bnb Mar 16, 2023 • edited

Choose a reason for hiding this comment

danielleadams commented Mar 16, 2023

panva commented Mar 16, 2023

panva Mar 16, 2023 • edited

Choose a reason for hiding this comment

panva Mar 16, 2023

Choose a reason for hiding this comment

danielleadams Mar 19, 2023

Choose a reason for hiding this comment

panva Mar 19, 2023

Choose a reason for hiding this comment

nodejs-github-bot commented Mar 24, 2023

panva commented Mar 29, 2023

panva commented Mar 29, 2023 • edited

github-actions bot commented Mar 29, 2023

panva commented Mar 29, 2023

danielleadams commented Mar 14, 2023 •

edited

danielleadams commented Mar 16, 2023 •

edited

bnb Mar 16, 2023 •

edited

panva Mar 16, 2023 •

edited

panva commented Mar 29, 2023 •

edited