actions/stale
1
0
Fork 0
mirror of https://github.com/actions/stale.git synced 2025-12-10 20:21:20 +00:00
Code Issues Packages Projects Releases Wiki Activity

feat(options): add new options to avoid stale base on comments (#494)

Browse Source 
* feat(options): add new options to avoid stale based on comments

Helping to close #441, #470, #435?
Closes #390 due to no activity

BREAKING CHANGES: the options related to remove-stale-when-updated will only check the updates, not the comment. It is only impactint the configurations using the value at false

* style(readme): fix table syntax due to rebase

* docs(readme): add permissions only for the new options
This commit is contained in:
Geoffrey Testelin
2021-06-14 15:56:55 +02:00
committed by GitHub
parent f1017f33dd
commit 1efddcbe9f
12 changed files with 827 additions and 79 deletions
Download Patch File Download Diff File Expand all files Collapse all files

73
src/classes/issues-processor.ts
View File

@@ -616,7 +616,28 @@ export class IssuesProcessor {
);
if (shouldRemoveStaleWhenUpdated) {
issueLogger.info(`The stale label should not be removed`);
issueLogger.info(
`The stale label should not be removed due to an update`
);
} else {
issueLogger.info(
`The stale label should be removed if all conditions met`
);
}
const shouldRemoveStaleWhenCommented: boolean =
this._shouldRemoveStaleWhenCommented(issue);
issueLogger.info(
`The option ${issueLogger.createOptionLink(
this._getRemoveStaleWhenCommentedUsedOptionName(issue)
)} is: ${LoggerService.cyan(shouldRemoveStaleWhenCommented)}`
);
if (shouldRemoveStaleWhenCommented) {
issueLogger.info(
`The stale label should not be removed due to a comment`
);
} else {
issueLogger.info(
`The stale label should be removed if all conditions met`
@@ -624,9 +645,18 @@ export class IssuesProcessor {
}
// Should we un-stale this issue?
if (shouldRemoveStaleWhenUpdated && issueHasComments) {
if (shouldRemoveStaleWhenUpdated && issueHasUpdate) {
issueLogger.info(
`Remove the stale label since the $$type has a comment and the workflow should remove the stale label when updated`
`Remove the stale label since the $$type has an update and the workflow should remove the stale label when updated`
);
await this._removeStaleLabel(issue, staleLabel);
issueLogger.info(`Skipping the process since the $$type is now un-stale`);
return; // Nothing to do because it is no longer stale
} else if (shouldRemoveStaleWhenCommented && issueHasComments) {
issueLogger.info(
`Remove the stale label since the $$type has a comment and the workflow should remove the stale label when commented`
);
await this._removeStaleLabel(issue, staleLabel);
@@ -1046,6 +1076,22 @@ export class IssuesProcessor {
}
}
private _shouldRemoveStaleWhenCommented(issue: Issue): boolean {
if (issue.isPullRequest) {
if (isBoolean(this.options.removePrStaleWhenCommented)) {
return this.options.removePrStaleWhenCommented;
}
return this.options.removeStaleWhenCommented;
}
if (isBoolean(this.options.removeIssueStaleWhenCommented)) {
return this.options.removeIssueStaleWhenCommented;
}
return this.options.removeStaleWhenCommented;
}
private async _removeStaleLabel(
issue: Issue,
staleLabel: Readonly<string>
@@ -1157,4 +1203,25 @@ export class IssuesProcessor {
return Option.RemoveStaleWhenUpdated;
}
private _getRemoveStaleWhenCommentedUsedOptionName(
issue: Readonly<Issue>
):
| Option.RemovePrStaleWhenCommented
| Option.RemoveStaleWhenCommented
| Option.RemoveIssueStaleWhenCommented {
if (issue.isPullRequest) {
if (isBoolean(this.options.removePrStaleWhenCommented)) {
return Option.RemovePrStaleWhenCommented;
}
return Option.RemoveStaleWhenCommented;
}
if (isBoolean(this.options.removeIssueStaleWhenCommented)) {
return Option.RemoveIssueStaleWhenCommented;
}
return Option.RemoveStaleWhenCommented;
}
}