ci: close stale issues and PRs automatically #11778

sigveio · 2021-08-24T07:13:04Z

Summary

This PR proposes two new jobs for the GitHub automated workflow.

They are based on the Close Stale Issues Github Action.

Details

Base conditions for all jobs:

Issues labeled Stale will be closed with no further activity after
- 5 days for issues
- 14 days for PRs.
The existing workflow would then lock after a further 30 days of inactivity.

Job: `"Close stale issues and PRs older than 12 months"`

Legacy cleanup to label all* issues and PRs with no activity for 1 year as Stale.

*Click to see exemptions!

These are exempt:

Labeled:
- Confirmed
- Discussion
- Documentation 📖
- good first issue
- Help Wanted
Has assignee
Has milestone

Impact 💥

This could potentially close almost 600 issues at this point in time.

It would also affect around 65 stale PRs.

Job: `"Close stale issues and PRs"`

Normal routine applying to all* new issues and PRs from this date forward.

Labels issues and PRs matching the following conditions as Stale:

Issues with activity for 30 days and still carrying the Needs Triage label.
PRs with no activity for 90 days.

These are exempt:

Has assignee
Has milestone

Motivation

Trimming down the amount of open issues and PRs could help make it easier to maintain an overview for those managing the project. I think it would also help make the project more approachable for potential contributors.

The new automated workflow would help take care of it going forward. 🤖 💙

Things to consider / discuss

This will fire off a lot of emails initially; but in my opinion it's worth it.
At the moment the "legacy" (1-year) job runs everything in one big batch. This should be fine, as Github AFAIK allows upto 5000 requests to the API per hour in this setting. And I feel it's less painful/intrusive to have one big surge of emails.
An even more aggressive approach is possible, but I found it prudent to start reasonably soft and rather do it in several "waves" over some time.
The bot should revert the labelling automatically if someone comments, reducing the need for any form of manual intervention for issues or PRs where users feel the Stale classification is incorrect.
The GitHub Action supports a "debug-only" dry-run mode, so we could test it out without making actual changes. And verify a random subset.

Todo before this could be merged:

Add Stale label
Consider removing 📖 -icon from Documentation label, as I'm not 100% sure if the bot plays well with it.
Could we clean up the labels in general? There are several unused or minimally used ones.

Warning

⚠️ Please note that these tasks are merely a draft based on documentation, and has not been tested yet. ⚠️

- Label all issues and PRs older than 1 year (except certain labels) as Stale, close if no further activity after warning period. - From this date forward, label issues with no activity for 30 days and still carrying the `Needs Triage` label as Stale, close if no further activity after warning period. - From this date forward, label PRs with no activity for 90 days as stale and close if no further activity after warning period. Issues and PRs with milestones or assignees are exempt.

codecov-commenter · 2021-08-24T07:38:32Z

Codecov Report

Merging #11778 (f0f4da6) into master (4f4062b) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master   #11778   +/-   ##
=======================================
  Coverage   69.01%   69.01%           
=======================================
  Files         312      312           
  Lines       16346    16346           
  Branches     4742     4742           
=======================================
  Hits        11281    11281           
  Misses       5037     5037           
  Partials       28       28

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 4f4062b...f0f4da6. Read the comment docs.

sigveio · 2021-08-24T08:08:44Z

I have updated it to use a dry-run mode.

Together with ACTIONS_RUNNER_DEBUG this could allow for some basic verification before it's thrown into the wild.

SimenB

Hey @sigveio! Sorry I dropped the ball on this.

I think this is something we want to - 1.5k open issues iss too many to reasonably be able to address. I've had some extra time in the last couple of weeks, but I've only reduced the PR count by about 40 , and not even looked at issues unless linked to PRs. Being able to close out old ones, and then having new ones opened which follow the great templates you put together seems reasonable to me.

SimenB · 2022-02-24T10:42:54Z

.github/workflows/close-stale-legacy.yml

+          days-before-pr-stale: 365
+          days-before-issue-close: 5
+          days-before-pr-close: 14
+          exempt-issue-labels: 'Confirmed,Discussion,Documentation :book:,good first issue,Help Wanted'


some sort of pinned?

SimenB · 2022-02-24T10:45:56Z

.github/workflows/close-stale-legacy.yml

+        with:
+          stale-issue-message: 'This issue is stale because it has been open for 1 year with no activity. Remove stale label or comment or this will be closed in 5 days.'
+          stale-pr-message: 'This PR is stale because it has been open 1 year with no activity. Remove stale label or comment or this will be closed in 10 days.'
+          close-issue-message: 'This issue was closed because it has been stalled for 5 days with no activity.'


should we have something about "open up a new issue following the template and link to this issue if still relevant" thing?

SimenB · 2022-02-25T10:58:42Z

Created the Stale label: https://github.com/facebook/jest/labels/Stale

SimenB · 2022-02-25T10:59:10Z

Could we clean up the labels in general? There are several unused or minimally used ones.

We should

SimenB · 2022-02-25T11:45:03Z

I tweaked this

encourage new issues/PRs linking to old ones
No exempted labels except an explicit Pinned
A single workflow - splitting into two files doesn't give us anything, AFAIK

I should also probably make a pinned issue explaining why we're doing and a place for people to provide feedback

SimenB

ok, let's try it. it's debug-only for now, so shouldn't actually do anything.

Thanks for getting this started @sigveio!

SimenB · 2022-02-25T12:41:53Z

Ok, looks good! Activated it and filed #12496. Thanks again @sigveio 🙂

github-actions · 2022-03-28T00:07:52Z

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.
Please note this issue tracker is not a help forum. We recommend using StackOverflow or our discord channel for questions.

facebook-github-bot added the cla signed label Aug 24, 2021

toggle debug/dry-run mode on

f0f4da6

sigveio marked this pull request as ready for review August 24, 2021 08:08

SimenB mentioned this pull request Feb 24, 2022

Feat #12305:-CI: Add new workflow for closing stale Pr and issues #12430

Closed

SimenB reviewed Feb 24, 2022

View reviewed changes

SimenB added 4 commits February 25, 2022 12:30

Merge branch 'main' into stale-issues

c116b6e

tweaks

4696226

every 10 minutes

a41f555

exempt pinned

c2d7419

SimenB added 2 commits February 25, 2022 12:47

single workflow

88ce413

no exempt draft pr year old

0116b4f

SimenB approved these changes Feb 25, 2022

View reviewed changes

SimenB merged commit ce7bc85 into jestjs:main Feb 25, 2022

github-actions bot locked as resolved and limited conversation to collaborators Mar 28, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

ci: close stale issues and PRs automatically #11778

ci: close stale issues and PRs automatically #11778

sigveio commented Aug 24, 2021 •

edited by SimenB

Loading

codecov-commenter commented Aug 24, 2021 •

edited

Loading

sigveio commented Aug 24, 2021

SimenB left a comment

SimenB Feb 24, 2022

SimenB Feb 24, 2022

SimenB commented Feb 25, 2022

SimenB commented Feb 25, 2022

SimenB commented Feb 25, 2022 •

edited

Loading

SimenB left a comment

SimenB commented Feb 25, 2022

github-actions bot commented Mar 28, 2022

ci: close stale issues and PRs automatically #11778

ci: close stale issues and PRs automatically #11778

Conversation

sigveio commented Aug 24, 2021 • edited by SimenB Loading

Summary

Details

Base conditions for all jobs:

Job: "Close stale issues and PRs older than 12 months"

Impact 💥

Job: "Close stale issues and PRs"

Motivation

Things to consider / discuss

Todo before this could be merged:

Warning

codecov-commenter commented Aug 24, 2021 • edited Loading

Codecov Report

sigveio commented Aug 24, 2021

SimenB left a comment

Choose a reason for hiding this comment

SimenB Feb 24, 2022

Choose a reason for hiding this comment

SimenB Feb 24, 2022

Choose a reason for hiding this comment

SimenB commented Feb 25, 2022

SimenB commented Feb 25, 2022

SimenB commented Feb 25, 2022 • edited Loading

SimenB left a comment

Choose a reason for hiding this comment

SimenB commented Feb 25, 2022

github-actions bot commented Mar 28, 2022

sigveio commented Aug 24, 2021 •

edited by SimenB

Loading

Job: `"Close stale issues and PRs older than 12 months"`

Job: `"Close stale issues and PRs"`

codecov-commenter commented Aug 24, 2021 •

edited

Loading

SimenB commented Feb 25, 2022 •

edited

Loading