Skip to content

Add GitHub Actions job for better triage process#1213

Merged
srajiang merged 1 commit intomainfrom
add-stale-git-action
Nov 18, 2021
Merged

Add GitHub Actions job for better triage process#1213
srajiang merged 1 commit intomainfrom
add-stale-git-action

Conversation

@srajiang
Copy link
Contributor

@srajiang srajiang commented Nov 18, 2021

Summary

This PR adds an action which will automate stale-ing and closing inactive issues. This action does not impact:

  • open PRs
  • issues attached to any release milestones, e.g. 3.x.
  • issues explicitly tagged with the label auto-triage-skip.

For inactive issues:

  • At 30-days old w/ no activity: The action will mark the issue with auto-triage-stale label and post a message in thread notifying all participants that after 10 further days w/out activity, the issue will be closed.
  • At 10 days after marked stale w/ no activity: Action will close the issue

For maintainers, and for the wider community:

👋 The goal with these changes is to make sure that issues are staying updated, as activity is the best indicator that it will be resolved! That means, if more info is needed and you need a bit more time to investigate, or if we need more time to investigate an issue internally, the best way to keep the issue updated is to post a comment!

Todo:

  • Reviewers - is weekly on Sundays a good cadence?
  • After review, merge to main and do a debug run
  • Update debug-only: false

Requirements (place an x in each [ ])

@srajiang srajiang force-pushed the add-stale-git-action branch from 4dc5a92 to 935f21e Compare November 18, 2021 21:15
@srajiang srajiang self-assigned this Nov 18, 2021
@srajiang srajiang added this to the 3.9.0 milestone Nov 18, 2021
@codecov
Copy link

codecov bot commented Nov 18, 2021

Codecov Report

Merging #1213 (2beece7) into main (020c44f) will not change coverage.
The diff coverage is n/a.

❗ Current head 2beece7 differs from pull request most recent head 7746a8f. Consider uploading reports for the commit 7746a8f to get more accurate results
Impacted file tree graph

@@           Coverage Diff           @@
##             main    #1213   +/-   ##
=======================================
  Coverage   73.20%   73.20%           
=======================================
  Files          17       17           
  Lines        1437     1437           
  Branches      431      431           
=======================================
  Hits         1052     1052           
  Misses        300      300           
  Partials       85       85           

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 020c44f...7746a8f. Read the comment docs.

Copy link
Contributor

@seratch seratch left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for working on this! I left a few comments.

days-before-issue-close: 10
days-before-pr-stale: -1
days-before-pr-close: -1
stale-issue-label: stale-no-activity
Copy link
Contributor

@seratch seratch Nov 18, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we use the term "auto-triage", consistently having the term in the labels may be easier to understand. Like this:

  • stale-issue-label: auto-triage-stale
  • exempt-issue-labels: auto-triage-skip

What do you think?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like that - I will add those updates.

- uses: actions/stale@v4.0.0
with:
days-before-issue-stale: 30
days-before-issue-close: 10
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

10 days sounds reasonable 👍

days-before-pr-close: -1
stale-issue-label: stale-no-activity
stale-issue-message: 👋 It looks like this issue has been open for 30 days with no activity. We'll mark this as stale for now, and wait 10 days for an update or for further comment before closing this issue out.
close-issue-message: This issue has been closed due to being inactive for 10 days with no further update.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

being inactive for 10 days with no further update.

In this situation, the issue should be inactive for 40+ days (30 days before being marked as stale, and then 10 days until closing), right?

Also, (perhaps, other maintainers can come up with a better sentence but) using a bit more friendly message like "As this issue has been inactive for more than one month, let us close this. Thanks again for writing in here!" or so may be fine.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How about:
"As this issue has been inactive for more than one month, we will be closing it. Thanks again for writing in!"

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, looks great 👍

Copy link
Contributor

@filmaj filmaj left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Echoing @seratch's comments, but LGTM in general!

@srajiang srajiang force-pushed the add-stale-git-action branch from 935f21e to 7746a8f Compare November 18, 2021 22:05
@srajiang srajiang merged commit 3e8a0f9 into main Nov 18, 2021
@seratch seratch deleted the add-stale-git-action branch November 18, 2021 22:16
exempt-all-milestones: true
remove-stale-when-updated: true
enable-statistics: true
debug-only: true # TODO: remove after test run No newline at end of file
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@srajiang when to remove this line?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very shortly - I'm reviewing the output of the test run now. If all clear on that and it's doing what I think it should be doing, we can remove it. I won't include this line for PRs in other repos.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The output is here: https://github.com/slackapi/bolt-js/runs/4257717061?check_suite_focus=true in case you'd like to review the triage results (when performed in debug mode).

Copy link
Member

@mwbrooks mwbrooks left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks awesome! Nice work.

days-before-pr-close: -1
stale-issue-label: auto-triage-stale
stale-issue-message: 👋 It looks like this issue has been open for 30 days with no activity. We'll mark this as stale for now, and wait 10 days for an update or for further comment before closing this issue out.
close-issue-message: As this issue has been inactive for more than one month, we will be closing it. Thanks again for writing in!
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we want to add a CTA that the issue can be re-opened if anyone wants? I'm cool either way.

@seratch seratch changed the title Add triage git action Add GitHub Actions job for better triage process Dec 16, 2021
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 this pull request may close these issues.

4 participants