build: close stalled issues and PRs with GitHub Action #34555

phillipj · 2020-07-29T18:52:59Z

This introduces a GitHub Action workflow to close issues and PRs which has been labelled stalled 30 days ago (or more).

stale labelling and unlabelling of issues and PRs are still done manually by collaborators.

For the curious ones, all the stale action options are described here: stale/action.yml.

Refs nodejs/github-bot#261

Checklist

commit message follows commit guidelines

phillipj · 2020-07-29T18:55:21Z

Hmz, which subsystem this belongs to was obvious to me.. Looking at the bot's label choice, I should have used meta?

phillipj · 2020-07-29T18:57:44Z

Example of this in practise can be seen in phillipj/stale-action-with-manual-labelling. Only difference being days since being labelled stalled is set to 1 instead of 30.

mscdex · 2020-07-29T19:08:43Z

Should this be leaving a message when closing?

mmarchini · 2020-07-29T22:02:52Z

Hmz, which subsystem this belongs to was obvious to me.. Looking at the bot's label choice, I should have used meta?

build is fine, the labels applied by the bot doesn't necessarily reflect the actual subsystem (we might want to change the bot to label .github/workflows with build though).

phillipj · 2020-07-30T07:05:18Z

Should this be leaving a message when closing?

I like the idea and is luckily configurable with close-issue-message | close-pr-message. Some kind of explanation is probably better than nothing and opening up for questions if any is good etiquette, right?

Closing this because it has stalled. Feel free to ping the collaborator who labelled it stalled if you have any questions.

Does that sound good to you @mscdex? Or du you have a more eloquent alternative?

mmarchini · 2020-07-30T07:19:37Z

Suggestion for the comments: Closing this because it has stalled. Feel free to reopen if this issue/PR is still relevant, or to ping the collaborator who labelled it stalled if you have any questions.

lundibundi · 2020-07-30T08:13:58Z

IMO it would be also cool to have an automatic comment that it was marked stalled and will be closed in 30 days as adding a label AFAIK doesn't trigger a GitHub notification and people will only know about it when the issue/PR is already closed.

lundibundi

LGTM after adding close-issue-message/close-pr-message

lundibundi · 2020-07-30T08:16:10Z

Also ping @Trott for closing message suggestions 😄.

mmarchini · 2020-07-30T15:59:52Z

@lundibundi it would be a good idea, but it wouldn't work for pull requests (because the vast majority comes from forks, which means the action that runs when a label is added to the PR won't have write access or access to secrets) and therefore it would be inconsistent between issues and PRs. We'll need to trust collaborators to leave a comment when labeling something as stalled

mscdex · 2020-07-30T16:05:56Z

@phillipj I don't have any particular preference on the wording but I think there should be some kind of explanation provided so that everyone understands why the close happened. Doing so would keep things in line with how manual closes have occurred on past issues/PRs.

lundibundi · 2020-07-30T16:45:02Z

@mmarchini That's unfortunate, though I think it would be better to at least have the message in the issues (and IMO it's more important for issues than it is for PRs) than to not have it in neither.
Not a blocker anyways just a suggestion/possible follow-ups.

phillipj · 2020-07-30T20:08:34Z

@lundibundi great suggestion for a follow up if we see this auto closing behaviour confuses contributors.

Although a bit tricky, it might be feasible.. Sounds a bit like what I've noticed the remove-stale-when-updated option activates; it goes through all stalled issues/PRs and removes the label if any comments are posted.

As far as I've understood, it circumvents what @mmarchini is raising by running on a cron schedule rather than reacting to action events like push | labeled etc.

Feels like something similar could be done to achieve what you're suggesting.

mhdawson

LGTM

phillipj · 2020-08-09T10:36:26Z

Let me know if there's anything expected of me before this can land. I don't have any upcoming changes in mind..

mmarchini · 2020-08-09T19:43:59Z

Was about to land it and create the stalled label. Turns out we already have that label and we have 44 issues and PRs with it: stalled Issues and PRs that are stalled. . Do we want the 30 days to start counting once we land this PR, or when the label was originally added? If the former, we need to remove and re-add the label before landing this.

mmarchini · 2020-08-10T07:55:28Z

There's a new GitHub Actions event which can be used on Pull Requests and has proper write access: pull_request_target. @phillipj can you add another Action which will automatically leave a comment when the label is added? Something like:

This issue/PR was marked as stalled by , it will be automatically closed in 30 days. If it should remain open, please leave a comment explaining why it should remain open.

To run the action only when specific labels are added, you can do:

on:
  issue:
    types: [labeled]
  pull_request_target:
    types: [labeled]

jobs:
  staleComment:
    runs-on: ubuntu-latest
    if: github.event.label.name == 'stalled'

Here's an example.

.github/workflows/comment-stalled.yml

mmarchini · 2020-08-10T20:56:21Z

.github/workflows/comment-stalled.yml

+  pull_request_target:
+    types: [labeled]


This won't work for existing PRs, but maybe that's ok.

I fumbled around quite a bit myself before discovering that as well... You know ways to circumvent that by any chance?

phillipj · 2020-08-18T09:12:55Z

As far as I'm concerned, this is the only unanswered question from @mmarchini:

Do we want the 30 days to start counting once we land this PR, or when the label was originally added? If the former, we need to remove and re-add the label before landing this.

Who can answer this? Is it a TSC concern?

mmarchini · 2020-08-18T18:16:41Z

@nodejs/tsc question: this PR will auto-close issues and PRs 30 days after the staled label is added to them (the label will be added only manually, by collaborators and triage team). We have quite a few issues and PRs with the label already, do we want to close those 30 days from when the label was added (which might mean closing them right after this PR lands), or do we want those to be closed 30 days after this PR lands?

targos · 2020-08-18T18:55:56Z

If it's the second option, will there be an automatic message posted to the issues which have the label?

mmarchini · 2020-08-18T19:07:09Z

If it's the second option, will there be an automatic message posted to the issues which have the label?

Yes for Issues, no for PRs (because we're using the pull_request_target event, which needs to be present in the PR git log for it to run, so it will only run on rebased PRs or new PRs. We can't use pull_request event because it doesn't have permission to comment).

mscdex · 2020-08-18T19:51:09Z

We can't use pull_request event because it doesn't have permission to comment).

Isn't that a simple fix that could be made by a repo admin?

mmarchini · 2020-08-18T19:56:19Z

No, that's a built-in limitation with the pull_request event

Trott · 2020-08-21T19:38:27Z

I mildly favor removing and re-adding the label so that the 30 days starts after the PR lands. But I also believe that people doing the work get to make the decisions when appropriate, and I think it's appropriate here, so if you want to auto-close those right away, that's fine too. People will get notifications and can always re-open them and/or remove the label and/or comment.

github-actions · 2020-09-02T23:30:45Z

Commit Queue failed

- Loading data for nodejs/node/pull/34555
✔  Done loading data for nodejs/node/pull/34555
----------------------------------- PR info ------------------------------------
Title      build: close stalled issues and PRs with GitHub Action (#34555)
   ⚠  Could not retrieve the email or name of the PR author's from user's GitHub profile!
Branch     phillipj:close-stalled-github-action -> nodejs:master
Labels     meta
Commits    4
 - build: close stalled issues and PRs with github action
 - fixup! build: close stalled issues and PRs with github action
 - build: comment about auto close when stalled via with github action
 - fixup! build: comment about auto close when stalled via with github a…
Committers 1
 - Phillip Johnsen 
PR-URL: https://github.com/nodejs/node/pull/34555
Reviewed-By: James M Snell 
Reviewed-By: Mary Marchini 
Reviewed-By: Denys Otrishko 
Reviewed-By: Gus Caplan 
Reviewed-By: Zeyu Yang 
Reviewed-By: Michael Dawson 
Reviewed-By: Shelley Vohr 
------------------------------ Generated metadata ------------------------------
PR-URL: https://github.com/nodejs/node/pull/34555
Reviewed-By: James M Snell 
Reviewed-By: Mary Marchini 
Reviewed-By: Denys Otrishko 
Reviewed-By: Gus Caplan 
Reviewed-By: Zeyu Yang 
Reviewed-By: Michael Dawson 
Reviewed-By: Shelley Vohr 
--------------------------------------------------------------------------------
   ✔  Last GitHub Actions successful
   ℹ  Last Full PR CI on 2020-09-02T22:35:12Z: https://ci.nodejs.org/job/node-test-pull-request/33025/
- Querying data for job/node-test-pull-request/33025/
✔  Build data downloaded
- Querying failures of job/node-test-commit/40579/
✔  Data downloaded
   ✖  2 failure(s) on the last Jenkins CI run
   ℹ  This PR was created on Wed, 29 Jul 2020 18:52:59 GMT
   ✔  Approvals: 7
   ✔  - James M Snell (@jasnell) (TSC): https://github.com/nodejs/node/pull/34555#pullrequestreview-457802366
   ✔  - Mary Marchini (@mmarchini) (TSC): https://github.com/nodejs/node/pull/34555#pullrequestreview-457930033
   ✔  - Denys Otrishko (@lundibundi): https://github.com/nodejs/node/pull/34555#pullrequestreview-458181195
   ✔  - Gus Caplan (@devsnek): https://github.com/nodejs/node/pull/34555#pullrequestreview-458544936
   ✔  - Zeyu Yang (@himself65): https://github.com/nodejs/node/pull/34555#pullrequestreview-458629607
   ✔  - Michael Dawson (@mhdawson) (TSC): https://github.com/nodejs/node/pull/34555#pullrequestreview-458746991
   ✔  - Shelley Vohr (@codebytere) (TSC): https://github.com/nodejs/node/pull/34555#pullrequestreview-481308862
--------------------------------------------------------------------------------
   ✔  Aborted `git node land` session in /home/runner/work/node/node/.ncu

mmarchini · 2020-09-03T00:36:46Z

i'll just go ahead and will land it manually 🙃

This introduces a GitHub Action workflow to close issues and PRs which has been labelled `stalled` 30 days ago (or more). `stale` labelling and unlabelling of issues and PRs are still done manually by collaborators. Refs nodejs/github-bot#261 PR-URL: #34555 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Mary Marchini <oss@mmarchini.me> Reviewed-By: Denys Otrishko <shishugi@gmail.com> Reviewed-By: Gus Caplan <me@gus.host> Reviewed-By: Zeyu Yang <himself65@outlook.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com> Reviewed-By: Shelley Vohr <codebytere@gmail.com>

mmarchini · 2020-09-03T00:52:13Z

Landed in cc9ac42...b23a932

This introduces a GitHub Action workflow to close issues and PRs which has been labelled `stalled` 30 days ago (or more). `stale` labelling and unlabelling of issues and PRs are still done manually by collaborators. Refs nodejs/github-bot#261 PR-URL: #34555 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Mary Marchini <oss@mmarchini.me> Reviewed-By: Denys Otrishko <shishugi@gmail.com> Reviewed-By: Gus Caplan <me@gus.host> Reviewed-By: Zeyu Yang <himself65@outlook.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com> Reviewed-By: Shelley Vohr <codebytere@gmail.com>

As part of automatically closing issues and PRs 30 days after they got labelled with `stalled`, these changes adds a GitHub Action workflow posting a comment information about what will happen in 30 days upon being labelled. PR-URL: #34555 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Mary Marchini <oss@mmarchini.me> Reviewed-By: Denys Otrishko <shishugi@gmail.com> Reviewed-By: Gus Caplan <me@gus.host> Reviewed-By: Zeyu Yang <himself65@outlook.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com> Reviewed-By: Shelley Vohr <codebytere@gmail.com>

This introduces a GitHub Action workflow to close issues and PRs which has been labelled `stalled` 30 days ago (or more). `stale` labelling and unlabelling of issues and PRs are still done manually by collaborators. Refs nodejs/github-bot#261 PR-URL: #34555 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Mary Marchini <oss@mmarchini.me> Reviewed-By: Denys Otrishko <shishugi@gmail.com> Reviewed-By: Gus Caplan <me@gus.host> Reviewed-By: Zeyu Yang <himself65@outlook.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com> Reviewed-By: Shelley Vohr <codebytere@gmail.com>

As part of automatically closing issues and PRs 30 days after they got labelled with `stalled`, these changes adds a GitHub Action workflow posting a comment information about what will happen in 30 days upon being labelled. PR-URL: #34555 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Mary Marchini <oss@mmarchini.me> Reviewed-By: Denys Otrishko <shishugi@gmail.com> Reviewed-By: Gus Caplan <me@gus.host> Reviewed-By: Zeyu Yang <himself65@outlook.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com> Reviewed-By: Shelley Vohr <codebytere@gmail.com>

This introduces a GitHub Action workflow to close issues and PRs which has been labelled `stalled` 30 days ago (or more). `stale` labelling and unlabelling of issues and PRs are still done manually by collaborators. Refs nodejs/github-bot#261 PR-URL: #34555 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Mary Marchini <oss@mmarchini.me> Reviewed-By: Denys Otrishko <shishugi@gmail.com> Reviewed-By: Gus Caplan <me@gus.host> Reviewed-By: Zeyu Yang <himself65@outlook.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com> Reviewed-By: Shelley Vohr <codebytere@gmail.com>

As part of automatically closing issues and PRs 30 days after they got labelled with `stalled`, these changes adds a GitHub Action workflow posting a comment information about what will happen in 30 days upon being labelled. PR-URL: #34555 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Mary Marchini <oss@mmarchini.me> Reviewed-By: Denys Otrishko <shishugi@gmail.com> Reviewed-By: Gus Caplan <me@gus.host> Reviewed-By: Zeyu Yang <himself65@outlook.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com> Reviewed-By: Shelley Vohr <codebytere@gmail.com>

This introduces a GitHub Action workflow to close issues and PRs which has been labelled `stalled` 30 days ago (or more). `stale` labelling and unlabelling of issues and PRs are still done manually by collaborators. Refs nodejs/github-bot#261 PR-URL: nodejs#34555 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Mary Marchini <oss@mmarchini.me> Reviewed-By: Denys Otrishko <shishugi@gmail.com> Reviewed-By: Gus Caplan <me@gus.host> Reviewed-By: Zeyu Yang <himself65@outlook.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com> Reviewed-By: Shelley Vohr <codebytere@gmail.com>

As part of automatically closing issues and PRs 30 days after they got labelled with `stalled`, these changes adds a GitHub Action workflow posting a comment information about what will happen in 30 days upon being labelled. PR-URL: nodejs#34555 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Mary Marchini <oss@mmarchini.me> Reviewed-By: Denys Otrishko <shishugi@gmail.com> Reviewed-By: Gus Caplan <me@gus.host> Reviewed-By: Zeyu Yang <himself65@outlook.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com> Reviewed-By: Shelley Vohr <codebytere@gmail.com>

nodejs-github-bot added the meta Issues and PRs related to the general management of the project. label Jul 29, 2020

jasnell approved these changes Jul 29, 2020

View reviewed changes

mmarchini approved these changes Jul 29, 2020

View reviewed changes

lundibundi approved these changes Jul 30, 2020

View reviewed changes

devsnek approved these changes Jul 30, 2020

View reviewed changes

himself65 approved these changes Jul 30, 2020

View reviewed changes

mhdawson approved these changes Jul 30, 2020

View reviewed changes

mmarchini reviewed Aug 10, 2020

View reviewed changes

github-actions bot added commit-queue-failed An error occurred while landing this pull request using GitHub Actions. and removed commit-queue Add this label to land a pull request using GitHub Actions. labels Sep 2, 2020

mmarchini closed this Sep 3, 2020

mmarchini force-pushed the close-stalled-github-action branch from 627616a to b23a932 Compare September 3, 2020 00:47

mmarchini merged commit b23a932 into nodejs:master Sep 3, 2020

phillipj deleted the close-stalled-github-action branch September 3, 2020 06:57

richardlau mentioned this pull request Sep 3, 2020

v14.10.0 proposal #35023

Merged

4 tasks

phillipj mentioned this pull request Sep 11, 2020

Stale action doesn't seem to be working #35144

Closed

codebytere mentioned this pull request Sep 28, 2020

v12.19.0 proposal #35401

Merged

targos removed the commit-queue-failed An error occurred while landing this pull request using GitHub Actions. label Sep 5, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

build: close stalled issues and PRs with GitHub Action #34555

build: close stalled issues and PRs with GitHub Action #34555

phillipj commented Jul 29, 2020

phillipj commented Jul 29, 2020

phillipj commented Jul 29, 2020

mscdex commented Jul 29, 2020

mmarchini commented Jul 29, 2020

phillipj commented Jul 30, 2020

mmarchini commented Jul 30, 2020

lundibundi commented Jul 30, 2020

lundibundi left a comment

lundibundi commented Jul 30, 2020

mmarchini commented Jul 30, 2020 •

edited

mscdex commented Jul 30, 2020

lundibundi commented Jul 30, 2020

phillipj commented Jul 30, 2020 •

edited

mhdawson left a comment

phillipj commented Aug 9, 2020

mmarchini commented Aug 9, 2020

mmarchini commented Aug 10, 2020

mmarchini Aug 10, 2020

phillipj Aug 10, 2020

mmarchini Aug 10, 2020

phillipj commented Aug 18, 2020

mmarchini commented Aug 18, 2020

targos commented Aug 18, 2020

mmarchini commented Aug 18, 2020 •

edited

mscdex commented Aug 18, 2020

mmarchini commented Aug 18, 2020 •

edited

Trott commented Aug 21, 2020

github-actions bot commented Sep 2, 2020

mmarchini commented Sep 3, 2020

mmarchini commented Sep 3, 2020

build: close stalled issues and PRs with GitHub Action #34555

build: close stalled issues and PRs with GitHub Action #34555

Conversation

phillipj commented Jul 29, 2020

Checklist

phillipj commented Jul 29, 2020

phillipj commented Jul 29, 2020

mscdex commented Jul 29, 2020

mmarchini commented Jul 29, 2020

phillipj commented Jul 30, 2020

mmarchini commented Jul 30, 2020

lundibundi commented Jul 30, 2020

lundibundi left a comment

Choose a reason for hiding this comment

lundibundi commented Jul 30, 2020

mmarchini commented Jul 30, 2020 • edited

mscdex commented Jul 30, 2020

lundibundi commented Jul 30, 2020

phillipj commented Jul 30, 2020 • edited

mhdawson left a comment

Choose a reason for hiding this comment

phillipj commented Aug 9, 2020

mmarchini commented Aug 9, 2020

mmarchini commented Aug 10, 2020

mmarchini Aug 10, 2020

Choose a reason for hiding this comment

phillipj Aug 10, 2020

Choose a reason for hiding this comment

mmarchini Aug 10, 2020

Choose a reason for hiding this comment

phillipj commented Aug 18, 2020

mmarchini commented Aug 18, 2020

targos commented Aug 18, 2020

mmarchini commented Aug 18, 2020 • edited

mscdex commented Aug 18, 2020

mmarchini commented Aug 18, 2020 • edited

Trott commented Aug 21, 2020

github-actions bot commented Sep 2, 2020

mmarchini commented Sep 3, 2020

mmarchini commented Sep 3, 2020

mmarchini commented Jul 30, 2020 •

edited

phillipj commented Jul 30, 2020 •

edited

mmarchini commented Aug 18, 2020 •

edited

mmarchini commented Aug 18, 2020 •

edited