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

dev-UX: Automatically close stale issues created by Check Broken Links action #5806

Closed
pysel opened this issue Jul 10, 2023 · 2 comments · Fixed by #5827
Closed

dev-UX: Automatically close stale issues created by Check Broken Links action #5806

pysel opened this issue Jul 10, 2023 · 2 comments · Fixed by #5827
Labels
github_actions Pull requests that update GitHub Actions code Good first issue Help wanted T:dev-UX

Comments

@pysel
Copy link
Member

pysel commented Jul 10, 2023

Background

We have a github workflow that searches for broken links in the repository and creates an issue that lists all broken links found. It runs approximately every 2 weeks.

This results that every 2 weeks an updated issue gets created, however, the old ones still sit in Issues list.

Suggested Design

I think it would be nice to automatically close them after an updated report is submitted, or after some time since the creation of this issue has elapses (15 days, for example). Not sure about the best way to go with here.

Acceptance Criteria

Broken Links Detected issues do not get piled up.

@inFocus7
Copy link
Contributor

Hmm, i think it's reasonable to close the issues every 15 days / every day we generate a new broken link issue.

Not sure if using the stale action is overkill (since I'm not sure how much processing and build minutes it'll cost), or if we'd just want to run a small sh.

But going the stale action route, we could probably add an extra step in the existing broken link workflow to go like:

  1. Close any stale issues with the broken link bot label (or just any unique label for them) and write message that if broken links exist there's a new issue for it. any-of-labels check, stale bot message field
  2. Create a new issue, if any, with the above unique label

@inFocus7
Copy link
Contributor

I created a PR for this, but its untested and would likely need to run the workflow/action to make sure it works as expected. It should theoretically work, but I couldn't find examples in the stale action documentation to automatically close issues...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
github_actions Pull requests that update GitHub Actions code Good first issue Help wanted T:dev-UX
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

2 participants