diff --git a/README.md b/README.md index b35614e4..045b8a63 100644 --- a/README.md +++ b/README.md @@ -246,8 +246,8 @@ Required Permission: `pull-requests: write` #### exempt-issue-labels -The label(s) that can exempt to automatically mark as stale the issues. -It can be a comma separated list of labels (e.g: `question,bug`). +Comma separated list of labels that exclude the issue from being marked as stale +(e.g: `question,bug`) If unset (or an empty string), this option will not alter the stale workflow. @@ -255,8 +255,8 @@ Default value: unset #### exempt-pr-labels -The label(s) that can exempt to automatically mark as stale the pull requests. -It can be a comma separated list of labels (e.g: `need-help,WIP`). +Comma separated list of labels that exclude the pull request from being marked as stale +(e.g: `need-help,WIP`) If unset (or an empty string), this option will not alter the stale workflow. diff --git a/dist/index.js b/dist/index.js index 0e78fccc..a2ddbb26 100644 --- a/dist/index.js +++ b/dist/index.js @@ -532,8 +532,10 @@ class IssuesProcessor { ? this.options.exemptPrLabels : this.options.exemptIssueLabels); if (exemptLabels.some((exemptLabel) => is_labeled_1.isLabeled(issue, exemptLabel))) { + // check to see if the issue is stale and has an exempt label + // see issue #136 for more details if (issue.isStale) { - issueLogger.info(`An exempt label was added after the stale label.`); + issueLogger.info(`This $$type has both an exempt and stale label, proceeding to remove the stale label.`); yield this._removeStaleLabel(issue, staleLabel); } issueLogger.info(`Skipping this $$type because it has an exempt label`); diff --git a/src/classes/issues-processor.ts b/src/classes/issues-processor.ts index 70e3bf24..c34ac334 100644 --- a/src/classes/issues-processor.ts +++ b/src/classes/issues-processor.ts @@ -337,8 +337,12 @@ export class IssuesProcessor { isLabeled(issue, exemptLabel) ) ) { + // check to see if the issue is stale and has an exempt label + // see issue #136 for more details if (issue.isStale) { - issueLogger.info(`An exempt label was added after the stale label.`); + issueLogger.info( + `This $$type has both an exempt and stale label, proceeding to remove the stale label.` + ); await this._removeStaleLabel(issue, staleLabel); }