ci: New workflow to update issues #3889
Conversation
This replaces an internal tool that we have been running on a private Jenkins server.
| const core = require('@actions/core'); | ||
|
|
||
| const octokit = github.getOctokit(process.env.GITHUB_TOKEN); | ||
| const [owner, repo] = process.env.GITHUB_REPOSITORY.split('/'); |
There was a problem hiding this comment.
These should probably be all-caps since they're constants even if they're dynamic.
There was a problem hiding this comment.
I prefer to keep them as-is, since it means I can use this syntax later in the queries:
{
owner,
repo,
}Instead of:
{
owner: OWNER,
repo: REPO,
}
Done. |
| const ARCHIVE_AFTER_CLOSED_DAYS = 60; | ||
|
|
||
|
|
||
| async function archiveOldIssues(issue) { |
There was a problem hiding this comment.
This is an operation on a single issue, even though the name specifies "Issues". You should probably rename it to archiveOldIssue. Same idea with the rest of these functions.
There was a problem hiding this comment.
I disagree. They accept a single issue at a time, so that the loop over issues is somewhat more efficient, but they are inherently filtering through issues (plural). If you try to describe what a function does in terms of a single issue, you end with much wordier names like "archiveIssueIfOld".
| } | ||
|
|
||
| async function manageWaitingIssues(issue) { | ||
| // Find all waiting issues. |
There was a problem hiding this comment.
This comment does not seem representative, since this method is not responsible for traversing the array of issues. Only manage waiting issues in this step. perhaps?
| async function maintainMilestones(issue, nextMilestone, backlog) { | ||
| // Set or remove milestones based on type labels. | ||
| if (!issue.closed) { | ||
| if (issue.hasAnyLabel(LABELS_FOR_NEXT_MILESTONE)) { |
There was a problem hiding this comment.
Perhaps it would make sense to add priority: P4 issues to the backlog, even if they are type: docs? We have a few p4 docs issues right now, and they are all marked as backlog.
There was a problem hiding this comment.
Done. I've set P3 and P4 as defaulting to the backlog in spite of the type.
| const ALL_ISSUE_TASKS = [ | ||
| archiveOldIssues, | ||
| unarchiveIssues, | ||
| reopenIssues, |
There was a problem hiding this comment.
Since the reopenIssues step happens after the archiveOldIssues step, does that mean that we might run into a situation where someone asks to re-open an issue at the very last moment and it archives instead?
There was a problem hiding this comment.
Good point. The original tool may have has this problem as well, since it was based on a python decorator and no explicit ordering. Fixed by moving reopenIssues to the top.
This ports over internal tests suggested in #3889.
github-actions
bot
added
the
status: archived
This replaces an internal tool that we have been running on a private
Jenkins server.