Compare commits

..

1 Commits

Author SHA1 Message Date
John Sudol
601cc005e7 update README and logs to provide clarity 2022-11-25 21:47:46 +00:00
3 changed files with 14 additions and 11 deletions

View File

@@ -246,7 +246,8 @@ Required Permission: `pull-requests: write`
#### exempt-issue-labels #### exempt-issue-labels
A comma separated list of labels, that prevent the issue from being marked as stale. (e.g: `question,bug,wip`) 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. If unset (or an empty string), this option will not alter the stale workflow.
@@ -254,8 +255,8 @@ Default value: unset
#### exempt-pr-labels #### exempt-pr-labels
The label(s) that can exempt to automatically mark as stale the pull requests. Comma separated list of labels that exclude the pull request from being marked as stale
It can be a comma separated list of labels (e.g: `need-help,WIP`). (e.g: `need-help,WIP`)
If unset (or an empty string), this option will not alter the stale workflow. If unset (or an empty string), this option will not alter the stale workflow.

9
dist/index.js vendored
View File

@@ -381,7 +381,7 @@ class IssuesProcessor {
this.options = options; this.options = options;
this.client = github_1.getOctokit(this.options.repoToken); this.client = github_1.getOctokit(this.options.repoToken);
this.operations = new stale_operations_1.StaleOperations(this.options); this.operations = new stale_operations_1.StaleOperations(this.options);
this._logger.info(logger_service_1.LoggerService.yellow(`Starting the stale action process... logging`)); this._logger.info(logger_service_1.LoggerService.yellow(`Starting the stale action process...`));
if (this.options.debugOnly) { if (this.options.debugOnly) {
this._logger.warning(logger_service_1.LoggerService.yellowBright(`Executing in debug mode!`)); this._logger.warning(logger_service_1.LoggerService.yellowBright(`Executing in debug mode!`));
this._logger.warning(logger_service_1.LoggerService.yellowBright(`The debug output will be written but no issues/PRs will be processed.`)); this._logger.warning(logger_service_1.LoggerService.yellowBright(`The debug output will be written but no issues/PRs will be processed.`));
@@ -526,15 +526,16 @@ class IssuesProcessor {
issueLogger.info(`This $$type has a stale label`); issueLogger.info(`This $$type has a stale label`);
} }
else { else {
issueLogger.info(`This $$type doesn't have a stale label`); issueLogger.info(`This $$type hasn't a stale label`);
} }
const exemptLabels = words_to_list_1.wordsToList(issue.isPullRequest const exemptLabels = words_to_list_1.wordsToList(issue.isPullRequest
? this.options.exemptPrLabels ? this.options.exemptPrLabels
: this.options.exemptIssueLabels); : this.options.exemptIssueLabels);
if (exemptLabels.some((exemptLabel) => is_labeled_1.isLabeled(issue, exemptLabel))) { 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) { 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.`);
issueLogger.info(`This $$type has an exempt label, removing the stale label.`);
yield this._removeStaleLabel(issue, staleLabel); yield this._removeStaleLabel(issue, staleLabel);
} }
issueLogger.info(`Skipping this $$type because it has an exempt label`); issueLogger.info(`Skipping this $$type because it has an exempt label`);

View File

@@ -78,7 +78,7 @@ export class IssuesProcessor {
this.operations = new StaleOperations(this.options); this.operations = new StaleOperations(this.options);
this._logger.info( this._logger.info(
LoggerService.yellow(`Starting the stale action process... logging`) LoggerService.yellow(`Starting the stale action process...`)
); );
if (this.options.debugOnly) { if (this.options.debugOnly) {
@@ -323,7 +323,7 @@ export class IssuesProcessor {
if (issue.isStale) { if (issue.isStale) {
issueLogger.info(`This $$type has a stale label`); issueLogger.info(`This $$type has a stale label`);
} else { } else {
issueLogger.info(`This $$type doesn't have a stale label`); issueLogger.info(`This $$type hasn't a stale label`);
} }
const exemptLabels: string[] = wordsToList( const exemptLabels: string[] = wordsToList(
@@ -337,10 +337,11 @@ export class IssuesProcessor {
isLabeled(issue, exemptLabel) 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) { if (issue.isStale) {
// issueLogger.info(`An exempt label was added after the stale label.`);
issueLogger.info( issueLogger.info(
`This $$type has an exempt label, removing the stale label.` `This $$type has both an exempt and stale label, proceeding to remove the stale label.`
); );
await this._removeStaleLabel(issue, staleLabel); await this._removeStaleLabel(issue, staleLabel);
} }