actions
/
stale
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

chore(logs): final overhaul of the logs (#433) 

* feat(logs): add a new log when an issue consumed at least one operation (#386)

* docs(only-labels): enhance the docs and fix duplicate (#341)

* docs(only-labels): remove duplicated option and improve descriptions

a bad rebase happend

* docs(readme): use a multi-line array and remove the optional column

the option column was not helpful since each value is optional
the multi-line array will allow to have a better UI in small devices and basically in GitHub too due to the max-width

* style(readme): break line for the statistics

* docs(readme): add a better description for the ascending option

* docs(action): add missing punctuation

* build(deps-dev): bump @typescript-eslint/eslint-plugin (#342)

Bumps [@typescript-eslint/eslint-plugin](https://github.com/typescript-eslint/typescript-eslint/tree/HEAD/packages/eslint-plugin) from 4.15.2 to 4.16.1.
- [Release notes](https://github.com/typescript-eslint/typescript-eslint/releases)
- [Changelog](https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/CHANGELOG.md)
- [Commits](https://github.com/typescript-eslint/typescript-eslint/commits/v4.16.1/packages/eslint-plugin)

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* build(deps): bump @octokit/rest from 18.3.0 to 18.3.2 (#350)

Bumps [@octokit/rest](https://github.com/octokit/rest.js) from 18.3.0 to 18.3.2.
- [Release notes](https://github.com/octokit/rest.js/releases)
- [Commits](https://github.com/octokit/rest.js/compare/v18.3.0...v18.3.2)

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* test: add more coverage for the stale label behaviour (#352) (#15)

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* test: add more coverage for the stale label behaviour (#352) (#17)

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* test: add more coverage for the stale label behaviour (#352) (#18)

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* docs(operations-per-run): improve the doc for this option

* feat(logs): add a new log when an issue consumed at least one operation

the log will be visible as the last row of the processing of the given issue
closes #348

* chore(readme): improve the operations per run

Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>

* chore(readme): improve the operations per run

Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>

* chore(readme): improve the operations per run

Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>

* chore(readme): improve the operations per run

Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>

* chore(readme): improve the operations per run

Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>

* chore(readme): improve the operations per run

Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>

* Typo in how to perform check for specific labels (#357)

Not tests but feels like a typo.

Or if we keep the title it `exempt` feels more approriate:

          exempt-issue-labels: 'roadmap'
          exempt-pr-labels: 'roadmap'

* feat(any-of-labels): add 2 new options to customize for issues/PRs (#380)

* docs(only-labels): enhance the docs and fix duplicate (#341)

* docs(only-labels): remove duplicated option and improve descriptions

a bad rebase happend

* docs(readme): use a multi-line array and remove the optional column

the option column was not helpful since each value is optional
the multi-line array will allow to have a better UI in small devices and basically in GitHub too due to the max-width

* style(readme): break line for the statistics

* docs(readme): add a better description for the ascending option

* docs(action): add missing punctuation

* build(deps-dev): bump @typescript-eslint/eslint-plugin (#342)

Bumps [@typescript-eslint/eslint-plugin](https://github.com/typescript-eslint/typescript-eslint/tree/HEAD/packages/eslint-plugin) from 4.15.2 to 4.16.1.
- [Release notes](https://github.com/typescript-eslint/typescript-eslint/releases)
- [Changelog](https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/CHANGELOG.md)
- [Commits](https://github.com/typescript-eslint/typescript-eslint/commits/v4.16.1/packages/eslint-plugin)

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* build(deps): bump @octokit/rest from 18.3.0 to 18.3.2 (#350)

Bumps [@octokit/rest](https://github.com/octokit/rest.js) from 18.3.0 to 18.3.2.
- [Release notes](https://github.com/octokit/rest.js/releases)
- [Commits](https://github.com/octokit/rest.js/compare/v18.3.0...v18.3.2)

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* test: add more coverage for the stale label behaviour (#352) (#15)

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* test: add more coverage for the stale label behaviour (#352) (#17)

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* test: add more coverage for the stale label behaviour (#352) (#18)

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* feat(any-of-labels): add 2 new options to customize for issues/PRs

closes #371
change this option and only-labels to have tree-logs

* chore(index): update it

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* feat(logs): enhance the logs for assignees and milestones (#382)

* docs(only-labels): enhance the docs and fix duplicate (#341)

* docs(only-labels): remove duplicated option and improve descriptions

a bad rebase happend

* docs(readme): use a multi-line array and remove the optional column

the option column was not helpful since each value is optional
the multi-line array will allow to have a better UI in small devices and basically in GitHub too due to the max-width

* style(readme): break line for the statistics

* docs(readme): add a better description for the ascending option

* docs(action): add missing punctuation

* build(deps-dev): bump @typescript-eslint/eslint-plugin (#342)

Bumps [@typescript-eslint/eslint-plugin](https://github.com/typescript-eslint/typescript-eslint/tree/HEAD/packages/eslint-plugin) from 4.15.2 to 4.16.1.
- [Release notes](https://github.com/typescript-eslint/typescript-eslint/releases)
- [Changelog](https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/CHANGELOG.md)
- [Commits](https://github.com/typescript-eslint/typescript-eslint/commits/v4.16.1/packages/eslint-plugin)

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* build(deps): bump @octokit/rest from 18.3.0 to 18.3.2 (#350)

Bumps [@octokit/rest](https://github.com/octokit/rest.js) from 18.3.0 to 18.3.2.
- [Release notes](https://github.com/octokit/rest.js/releases)
- [Commits](https://github.com/octokit/rest.js/compare/v18.3.0...v18.3.2)

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* test: add more coverage for the stale label behaviour (#352) (#15)

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* test: add more coverage for the stale label behaviour (#352) (#17)

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* test: add more coverage for the stale label behaviour (#352) (#18)

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* feat(logs): enhance the logs for assignees and milestones

closes #381

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* style(typo): fix typo plural issue

* style(naming): rename two methods

* chore(error): remove a potential useless throw of error

* style(naming): rename one method

* refactor(issue): change the way to count the operations

* refactor(operations): create a method to reduce code duplication

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>
Co-authored-by: Romain Rigaux <romain.rigaux@gmail.com>

* chore(logs): final overhaul of the logs

display more values in cyan
display all the options the same way (with links pointing to the readme so that with anchors we could find them easily later
make them a little more humanized
add more logs especially for the stale conditions

* style(logs): fix typos

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>
Co-authored-by: Romain Rigaux <romain.rigaux@gmail.com>
This commit is contained in:
Geoffrey Testelin 2021-05-12 16:00:14 +02:00 committed by GitHub
parent 523075947f
commit 98ed4cb500
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 198 additions and 70 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

95
dist/index.js vendored
View File

@ -33,7 +33,7 @@ class Assignees {
return false; return false;
} }
if (this._shouldExemptAllAssignees()) { if (this._shouldExemptAllAssignees()) {
this._issueLogger.info(chalk_1.default.white('└──'), 'Skipping $$type because it has an exempt assignee'); this._issueLogger.info(chalk_1.default.white('└──'), 'Skipping this $$type because it has an exempt assignee');
return true; return true;
} }
const exemptAssignees = this._getExemptAssignees(); const exemptAssignees = this._getExemptAssignees();
@ -280,6 +280,11 @@ class IssuesProcessor {
issueLogger.info(chalk_1.default.cyan(consumedOperationsCount), `operation${consumedOperationsCount > 1 ? 's' : ''} consumed for this $$type`); issueLogger.info(chalk_1.default.cyan(consumedOperationsCount), `operation${consumedOperationsCount > 1 ? 's' : ''} consumed for this $$type`);
} }
} }
static _getStaleMessageUsedOptionName(issue) {
return issue.isPullRequest
? option_1.Option.StalePrMessage
: option_1.Option.StaleIssueMessage;
}
processIssues(page = 1) { processIssues(page = 1) {
var _a, _b; var _a, _b;
return __awaiter(this, void 0, void 0, function* () { return __awaiter(this, void 0, void 0, function* () {
@ -297,7 +302,7 @@ class IssuesProcessor {
for (const issue of issues.values()) { for (const issue of issues.values()) {
const issueLogger = new issue_logger_1.IssueLogger(issue); const issueLogger = new issue_logger_1.IssueLogger(issue);
(_b = this._statistics) === null || _b === void 0 ? void 0 : _b.incrementProcessedItemsCount(issue); (_b = this._statistics) === null || _b === void 0 ? void 0 : _b.incrementProcessedItemsCount(issue);
issueLogger.info(`Found this $$type last updated ${issue.updated_at}`); issueLogger.info(`Found this $$type last updated at: ${chalk_1.default.cyan(issue.updated_at)}`);
// calculate string based messages for this issue // calculate string based messages for this issue
const staleMessage = issue.isPullRequest const staleMessage = issue.isPullRequest
? this.options.stalePrMessage ? this.options.stalePrMessage
@ -319,7 +324,7 @@ class IssuesProcessor {
: this._getDaysBeforeIssueStale(); : this._getDaysBeforeIssueStale();
const onlyLabels = words_to_list_1.wordsToList(this._getOnlyLabels(issue)); const onlyLabels = words_to_list_1.wordsToList(this._getOnlyLabels(issue));
if (onlyLabels.length > 0) { if (onlyLabels.length > 0) {
issueLogger.info(`The option "onlyLabels" was specified to only processed the issues and pull requests with all those labels (${onlyLabels.length})`); issueLogger.info(`The option ${issueLogger.createOptionLink(option_1.Option.OnlyLabels)} was specified to only process issues and pull requests with all those labels (${chalk_1.default.cyan(onlyLabels.length)})`);
const hasAllWhitelistedLabels = onlyLabels.every((label) => { const hasAllWhitelistedLabels = onlyLabels.every((label) => {
return is_labeled_1.isLabeled(issue, label); return is_labeled_1.isLabeled(issue, label);
}); });
@ -334,23 +339,23 @@ class IssuesProcessor {
} }
} }
else { else {
issueLogger.info(`The option "onlyLabels" was not specified`); issueLogger.info(`The option ${issueLogger.createOptionLink(option_1.Option.OnlyLabels)} was not specified`);
issueLogger.info(chalk_1.default.white('└──'), `Continuing the process for this $$type`); issueLogger.info(chalk_1.default.white('└──'), `Continuing the process for this $$type`);
} }
issueLogger.info(`Days before $$type stale: ${daysBeforeStale}`); issueLogger.info(`Days before $$type stale: ${chalk_1.default.cyan(daysBeforeStale)}`);
const shouldMarkAsStale = should_mark_when_stale_1.shouldMarkWhenStale(daysBeforeStale); const shouldMarkAsStale = should_mark_when_stale_1.shouldMarkWhenStale(daysBeforeStale);
if (!staleMessage && shouldMarkAsStale) { if (!staleMessage && shouldMarkAsStale) {
issueLogger.info(`Skipping $$type due to empty stale message`); issueLogger.info(`Skipping this $$type because it should be marked as stale based on the option ${issueLogger.createOptionLink(this._getDaysBeforeStaleUsedOptionName(issue))} (${chalk_1.default.cyan(daysBeforeStale)}) but the option ${issueLogger.createOptionLink(IssuesProcessor._getStaleMessageUsedOptionName(issue))} is not set`);
IssuesProcessor._endIssueProcessing(issue); IssuesProcessor._endIssueProcessing(issue);
continue; continue;
} }
if (issue.state === 'closed') { if (issue.state === 'closed') {
issueLogger.info(`Skipping $$type because it is closed`); issueLogger.info(`Skipping this $$type because it is closed`);
IssuesProcessor._endIssueProcessing(issue); IssuesProcessor._endIssueProcessing(issue);
continue; // Don't process closed issues continue; // Don't process closed issues
} }
if (issue.locked) { if (issue.locked) {
issueLogger.info(`Skipping $$type because it is locked`); issueLogger.info(`Skipping this $$type because it is locked`);
IssuesProcessor._endIssueProcessing(issue); IssuesProcessor._endIssueProcessing(issue);
continue; // Don't process locked issues continue; // Don't process locked issues
} }
@ -359,16 +364,16 @@ class IssuesProcessor {
if (this.options.startDate) { if (this.options.startDate) {
const startDate = new Date(this.options.startDate); const startDate = new Date(this.options.startDate);
const createdAt = new Date(issue.created_at); const createdAt = new Date(issue.created_at);
issueLogger.info(`A start date was specified for the ${get_humanized_date_1.getHumanizedDate(startDate)} (${this.options.startDate})`); issueLogger.info(`A start date was specified for the ${get_humanized_date_1.getHumanizedDate(startDate)} (${chalk_1.default.cyan(this.options.startDate)})`);
// Expecting that GitHub will always set a creation date on the issues and PRs // Expecting that GitHub will always set a creation date on the issues and PRs
// But you never know! // But you never know!
if (!is_valid_date_1.isValidDate(createdAt)) { if (!is_valid_date_1.isValidDate(createdAt)) {
IssuesProcessor._endIssueProcessing(issue); IssuesProcessor._endIssueProcessing(issue);
core.setFailed(new Error(`Invalid issue field: "created_at". Expected a valid date`)); core.setFailed(new Error(`Invalid issue field: "created_at". Expected a valid date`));
} }
issueLogger.info(`$$type created the ${get_humanized_date_1.getHumanizedDate(createdAt)} (${issue.created_at})`); issueLogger.info(`$$type created the ${get_humanized_date_1.getHumanizedDate(createdAt)} (${chalk_1.default.cyan(issue.created_at)})`);
if (!is_date_more_recent_than_1.isDateMoreRecentThan(createdAt, startDate)) { if (!is_date_more_recent_than_1.isDateMoreRecentThan(createdAt, startDate)) {
issueLogger.info(`Skipping $$type because it was created before the specified start date`); issueLogger.info(`Skipping this $$type because it was created before the specified start date`);
IssuesProcessor._endIssueProcessing(issue); IssuesProcessor._endIssueProcessing(issue);
continue; // Don't process issues which were created before the start date continue; // Don't process issues which were created before the start date
} }
@ -387,13 +392,13 @@ class IssuesProcessor {
issueLogger.info(`An exempt label was added after the stale label.`); issueLogger.info(`An exempt label was added after the stale label.`);
yield this._removeStaleLabel(issue, staleLabel); yield this._removeStaleLabel(issue, staleLabel);
} }
issueLogger.info(`Skipping $$type because it has an exempt label`); issueLogger.info(`Skipping this $$type because it has an exempt label`);
IssuesProcessor._endIssueProcessing(issue); IssuesProcessor._endIssueProcessing(issue);
continue; // Don't process exempt issues continue; // Don't process exempt issues
} }
const anyOfLabels = words_to_list_1.wordsToList(this._getAnyOfLabels(issue)); const anyOfLabels = words_to_list_1.wordsToList(this._getAnyOfLabels(issue));
if (anyOfLabels.length > 0) { if (anyOfLabels.length > 0) {
issueLogger.info(`The option "anyOfLabels" was specified to only processed the issues and pull requests with one of those labels (${anyOfLabels.length})`); issueLogger.info(`The option ${issueLogger.createOptionLink(option_1.Option.AnyOfLabels)} was specified to only process the issues and pull requests with one of those labels (${chalk_1.default.cyan(anyOfLabels.length)})`);
const hasOneOfWhitelistedLabels = anyOfLabels.some((label) => { const hasOneOfWhitelistedLabels = anyOfLabels.some((label) => {
return is_labeled_1.isLabeled(issue, label); return is_labeled_1.isLabeled(issue, label);
}); });
@ -408,7 +413,7 @@ class IssuesProcessor {
} }
} }
else { else {
issueLogger.info(`The option "anyOfLabels" was not specified`); issueLogger.info(`The option ${issueLogger.createOptionLink(option_1.Option.AnyOfLabels)} was not specified`);
issueLogger.info(chalk_1.default.white('└──'), `Continuing the process for this $$type`); issueLogger.info(chalk_1.default.white('└──'), `Continuing the process for this $$type`);
} }
const milestones = new milestones_1.Milestones(this.options, issue); const milestones = new milestones_1.Milestones(this.options, issue);
@ -424,17 +429,28 @@ class IssuesProcessor {
// Should this issue be marked stale? // Should this issue be marked stale?
const shouldBeStale = !IssuesProcessor._updatedSince(issue.updated_at, daysBeforeStale); const shouldBeStale = !IssuesProcessor._updatedSince(issue.updated_at, daysBeforeStale);
// Determine if this issue needs to be marked stale first // Determine if this issue needs to be marked stale first
if (!issue.isStale && shouldBeStale && shouldMarkAsStale) { if (!issue.isStale) {
issueLogger.info(`Marking $$type stale because it was last updated on ${issue.updated_at} and it does not have a stale label`); issueLogger.info(`This $$type is not stale`);
yield this._markStale(issue, staleMessage, staleLabel, skipMessage); const updatedAtDate = new Date(issue.updated_at);
issue.isStale = true; // This issue is now considered stale if (shouldBeStale) {
} issueLogger.info(`This $$type should be stale based on the last update date the ${get_humanized_date_1.getHumanizedDate(updatedAtDate)} (${chalk_1.default.cyan(issue.updated_at)})`);
else if (!issue.isStale) { if (shouldMarkAsStale) {
issueLogger.info(`Not marking as stale: shouldBeStale=${shouldBeStale}, shouldMarkAsStale=${shouldMarkAsStale}`); issueLogger.info(`This $$type should be marked as stale based on the option ${issueLogger.createOptionLink(this._getDaysBeforeStaleUsedOptionName(issue))} (${chalk_1.default.cyan(daysBeforeStale)})`);
yield this._markStale(issue, staleMessage, staleLabel, skipMessage);
issue.isStale = true; // This issue is now considered stale
issueLogger.info(`This $$type is now stale`);
}
else {
issueLogger.info(`This $$type should not be marked as stale based on the option ${issueLogger.createOptionLink(this._getDaysBeforeStaleUsedOptionName(issue))} (${chalk_1.default.cyan(daysBeforeStale)})`);
}
}
else {
issueLogger.info(`This $$type should not be stale based on the last update date the ${get_humanized_date_1.getHumanizedDate(updatedAtDate)} (${chalk_1.default.cyan(issue.updated_at)})`);
}
} }
// Process the issue if it was marked stale // Process the issue if it was marked stale
if (issue.isStale) { if (issue.isStale) {
issueLogger.info(`Found a stale $$type`); issueLogger.info(`This $$type is already stale`);
yield this._processStaleIssue(issue, staleLabel, actor, closeMessage, closeLabel); yield this._processStaleIssue(issue, staleLabel, actor, closeMessage, closeLabel);
} }
IssuesProcessor._endIssueProcessing(issue); IssuesProcessor._endIssueProcessing(issue);
@ -516,7 +532,7 @@ class IssuesProcessor {
var _a; var _a;
return __awaiter(this, void 0, void 0, function* () { return __awaiter(this, void 0, void 0, function* () {
const issueLogger = new issue_logger_1.IssueLogger(issue); const issueLogger = new issue_logger_1.IssueLogger(issue);
issueLogger.info(`Checking for label on $$type`); issueLogger.info(`Checking for label on this $$type`);
this._consumeIssueOperation(issue); this._consumeIssueOperation(issue);
(_a = this._statistics) === null || _a === void 0 ? void 0 : _a.incrementFetchedItemsEventsCount(); (_a = this._statistics) === null || _a === void 0 ? void 0 : _a.incrementFetchedItemsEventsCount();
const options = this.client.issues.listEvents.endpoint.merge({ const options = this.client.issues.listEvents.endpoint.merge({
@ -546,7 +562,7 @@ class IssuesProcessor {
const daysBeforeClose = issue.isPullRequest const daysBeforeClose = issue.isPullRequest
? this._getDaysBeforePrClose() ? this._getDaysBeforePrClose()
: this._getDaysBeforeIssueClose(); : this._getDaysBeforeIssueClose();
issueLogger.info(`Days before $$type close: ${daysBeforeClose}`); issueLogger.info(`Days before $$type close: ${chalk_1.default.cyan(daysBeforeClose)}`);
const issueHasUpdate = IssuesProcessor._updatedSince(issue.updated_at, daysBeforeClose); const issueHasUpdate = IssuesProcessor._updatedSince(issue.updated_at, daysBeforeClose);
issueLogger.info(`$$type has been updated: ${chalk_1.default.cyan(issueHasUpdate)}`); issueLogger.info(`$$type has been updated: ${chalk_1.default.cyan(issueHasUpdate)}`);
// should we un-stale this issue? // should we un-stale this issue?
@ -560,10 +576,10 @@ class IssuesProcessor {
return; // nothing to do because we aren't closing stale issues return; // nothing to do because we aren't closing stale issues
} }
if (!issueHasComments && !issueHasUpdate) { if (!issueHasComments && !issueHasUpdate) {
issueLogger.info(`Closing $$type because it was last updated on ${issue.updated_at}`); issueLogger.info(`Closing $$type because it was last updated on! ${chalk_1.default.cyan(issue.updated_at)}`);
yield this._closeIssue(issue, closeMessage, closeLabel); yield this._closeIssue(issue, closeMessage, closeLabel);
if (this.options.deleteBranch && issue.pull_request) { if (this.options.deleteBranch && issue.pull_request) {
issueLogger.info(`Deleting branch for as delete-branch option was specified`); issueLogger.info(`Deleting the branch the option ${issueLogger.createOptionLink(option_1.Option.DeleteBranch)} was specified`);
yield this._deleteBranch(issue); yield this._deleteBranch(issue);
this.deletedBranchIssues.push(issue); this.deletedBranchIssues.push(issue);
} }
@ -577,14 +593,14 @@ class IssuesProcessor {
_hasCommentsSince(issue, sinceDate, actor) { _hasCommentsSince(issue, sinceDate, actor) {
return __awaiter(this, void 0, void 0, function* () { return __awaiter(this, void 0, void 0, function* () {
const issueLogger = new issue_logger_1.IssueLogger(issue); const issueLogger = new issue_logger_1.IssueLogger(issue);
issueLogger.info(`Checking for comments on $$type since ${sinceDate}`); issueLogger.info(`Checking for comments on $$type since: ${chalk_1.default.cyan(sinceDate)}`);
if (!sinceDate) { if (!sinceDate) {
return true; return true;
} }
// find any comments since the date // find any comments since the date
const comments = yield this.listIssueComments(issue.number, sinceDate); const comments = yield this.listIssueComments(issue.number, sinceDate);
const filteredComments = comments.filter(comment => comment.user.type === 'User' && comment.user.login !== actor); const filteredComments = comments.filter(comment => comment.user.type === 'User' && comment.user.login !== actor);
issueLogger.info(`Comments not made by actor or another bot: ${filteredComments.length}`); issueLogger.info(`Comments not made by actor or another bot: ${chalk_1.default.cyan(filteredComments.length)}`);
// if there are any user comments returned // if there are any user comments returned
return filteredComments.length > 0; return filteredComments.length > 0;
}); });
@ -594,7 +610,7 @@ class IssuesProcessor {
var _a, _b, _c; var _a, _b, _c;
return __awaiter(this, void 0, void 0, function* () { return __awaiter(this, void 0, void 0, function* () {
const issueLogger = new issue_logger_1.IssueLogger(issue); const issueLogger = new issue_logger_1.IssueLogger(issue);
issueLogger.info(`Marking $$type as stale`); issueLogger.info(`Marking this $$type as stale`);
this.staleIssues.push(issue); this.staleIssues.push(issue);
// if the issue is being marked stale, the updated date should be changed to right now // if the issue is being marked stale, the updated date should be changed to right now
// so that close calculations work correctly // so that close calculations work correctly
@ -719,7 +735,7 @@ class IssuesProcessor {
issueLogger.info(`Delete branch from closed $$type - ${issue.title}`); issueLogger.info(`Delete branch from closed $$type - ${issue.title}`);
const pullRequest = yield this._getPullRequest(issue); const pullRequest = yield this._getPullRequest(issue);
if (!pullRequest) { if (!pullRequest) {
issueLogger.info(`Not deleting branch as pull request not found for this $$type`); issueLogger.info(`Not deleting this branch as no pull request was found for this $$type`);
return; return;
} }
if (this.options.debugOnly) { if (this.options.debugOnly) {
@ -746,7 +762,7 @@ class IssuesProcessor {
var _a; var _a;
return __awaiter(this, void 0, void 0, function* () { return __awaiter(this, void 0, void 0, function* () {
const issueLogger = new issue_logger_1.IssueLogger(issue); const issueLogger = new issue_logger_1.IssueLogger(issue);
issueLogger.info(`Removing the label "${chalk_1.default.cyan(label)}" from the $$type...`); issueLogger.info(`Removing the label "${chalk_1.default.cyan(label)}" from this $$type...`);
this.removedLabelIssues.push(issue); this.removedLabelIssues.push(issue);
if (this.options.debugOnly) { if (this.options.debugOnly) {
return; return;
@ -854,6 +870,21 @@ class IssuesProcessor {
this._operations.consumeOperation(); this._operations.consumeOperation();
issue.operations.consumeOperation(); issue.operations.consumeOperation();
} }
_getDaysBeforeStaleUsedOptionName(issue) {
return issue.isPullRequest
? this._getDaysBeforePrStaleUsedOptionName()
: this._getDaysBeforeIssueStaleUsedOptionName();
}
_getDaysBeforeIssueStaleUsedOptionName() {
return isNaN(this.options.daysBeforeIssueStale)
? option_1.Option.DaysBeforeStale
: option_1.Option.DaysBeforeIssueStale;
}
_getDaysBeforePrStaleUsedOptionName() {
return isNaN(this.options.daysBeforePrStale)
? option_1.Option.DaysBeforeStale
: option_1.Option.DaysBeforePrStale;
}
} }
exports.IssuesProcessor = IssuesProcessor; exports.IssuesProcessor = IssuesProcessor;
@ -1018,7 +1049,7 @@ class Milestones {
return false; return false;
} }
if (this._shouldExemptAllMilestones()) { if (this._shouldExemptAllMilestones()) {
this._issueLogger.info(chalk_1.default.white('└──'), 'Skipping $$type because it has a milestone'); this._issueLogger.info(chalk_1.default.white('└──'), 'Skipping this $$type because it has a milestone');
return true; return true;
} }
const exemptMilestones = this._getExemptMilestones(); const exemptMilestones = this._getExemptMilestones();

2
src/classes/assignees.ts
View File

@ -35,7 +35,7 @@ export class Assignees {
if (this._shouldExemptAllAssignees()) { if (this._shouldExemptAllAssignees()) {
this._issueLogger.info( this._issueLogger.info(
chalk.white('└──'), chalk.white('└──'),
'Skipping $$type because it has an exempt assignee' 'Skipping this $$type because it has an exempt assignee'
); );
return true; return true;

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

@ -51,6 +51,14 @@ export class IssuesProcessor {
} }
} }
private static _getStaleMessageUsedOptionName(
issue: Readonly<Issue>
): Option.StalePrMessage | Option.StaleIssueMessage {
return issue.isPullRequest
? Option.StalePrMessage
: Option.StaleIssueMessage;
}
private readonly _logger: Logger = new Logger(); private readonly _logger: Logger = new Logger();
private readonly _operations: StaleOperations; private readonly _operations: StaleOperations;
private readonly _statistics: Statistics | undefined; private readonly _statistics: Statistics | undefined;
@ -112,7 +120,9 @@ export class IssuesProcessor {
const issueLogger: IssueLogger = new IssueLogger(issue); const issueLogger: IssueLogger = new IssueLogger(issue);
this._statistics?.incrementProcessedItemsCount(issue); this._statistics?.incrementProcessedItemsCount(issue);
issueLogger.info(`Found this $$type last updated ${issue.updated_at}`); issueLogger.info(
`Found this $$type last updated at: ${chalk.cyan(issue.updated_at)}`
);
// calculate string based messages for this issue // calculate string based messages for this issue
const staleMessage: string = issue.isPullRequest const staleMessage: string = issue.isPullRequest
@ -137,7 +147,11 @@ export class IssuesProcessor {
if (onlyLabels.length > 0) { if (onlyLabels.length > 0) {
issueLogger.info( issueLogger.info(
`The option "onlyLabels" was specified to only processed the issues and pull requests with all those labels (${onlyLabels.length})` `The option ${issueLogger.createOptionLink(
Option.OnlyLabels
)} was specified to only process issues and pull requests with all those labels (${chalk.cyan(
onlyLabels.length
)})`
); );
const hasAllWhitelistedLabels: boolean = onlyLabels.every( const hasAllWhitelistedLabels: boolean = onlyLabels.every(
@ -165,31 +179,45 @@ export class IssuesProcessor {
); );
} }
} else { } else {
issueLogger.info(`The option "onlyLabels" was not specified`); issueLogger.info(
`The option ${issueLogger.createOptionLink(
Option.OnlyLabels
)} was not specified`
);
issueLogger.info( issueLogger.info(
chalk.white('└──'), chalk.white('└──'),
`Continuing the process for this $$type` `Continuing the process for this $$type`
); );
} }
issueLogger.info(`Days before $$type stale: ${daysBeforeStale}`); issueLogger.info(
`Days before $$type stale: ${chalk.cyan(daysBeforeStale)}`
);
const shouldMarkAsStale: boolean = shouldMarkWhenStale(daysBeforeStale); const shouldMarkAsStale: boolean = shouldMarkWhenStale(daysBeforeStale);
if (!staleMessage && shouldMarkAsStale) { if (!staleMessage && shouldMarkAsStale) {
issueLogger.info(`Skipping $$type due to empty stale message`); issueLogger.info(
`Skipping this $$type because it should be marked as stale based on the option ${issueLogger.createOptionLink(
this._getDaysBeforeStaleUsedOptionName(issue)
)} (${chalk.cyan(
daysBeforeStale
)}) but the option ${issueLogger.createOptionLink(
IssuesProcessor._getStaleMessageUsedOptionName(issue)
)} is not set`
);
IssuesProcessor._endIssueProcessing(issue); IssuesProcessor._endIssueProcessing(issue);
continue; continue;
} }
if (issue.state === 'closed') { if (issue.state === 'closed') {
issueLogger.info(`Skipping $$type because it is closed`); issueLogger.info(`Skipping this $$type because it is closed`);
IssuesProcessor._endIssueProcessing(issue); IssuesProcessor._endIssueProcessing(issue);
continue; // Don't process closed issues continue; // Don't process closed issues
} }
if (issue.locked) { if (issue.locked) {
issueLogger.info(`Skipping $$type because it is locked`); issueLogger.info(`Skipping this $$type because it is locked`);
IssuesProcessor._endIssueProcessing(issue); IssuesProcessor._endIssueProcessing(issue);
continue; // Don't process locked issues continue; // Don't process locked issues
} }
@ -202,9 +230,9 @@ export class IssuesProcessor {
const createdAt: Date = new Date(issue.created_at); const createdAt: Date = new Date(issue.created_at);
issueLogger.info( issueLogger.info(
`A start date was specified for the ${getHumanizedDate(startDate)} (${ `A start date was specified for the ${getHumanizedDate(
this.options.startDate startDate
})` )} (${chalk.cyan(this.options.startDate)})`
); );
// Expecting that GitHub will always set a creation date on the issues and PRs // Expecting that GitHub will always set a creation date on the issues and PRs
@ -219,14 +247,14 @@ export class IssuesProcessor {
} }
issueLogger.info( issueLogger.info(
`$$type created the ${getHumanizedDate(createdAt)} (${ `$$type created the ${getHumanizedDate(createdAt)} (${chalk.cyan(
issue.created_at issue.created_at
})` )})`
); );
if (!isDateMoreRecentThan(createdAt, startDate)) { if (!isDateMoreRecentThan(createdAt, startDate)) {
issueLogger.info( issueLogger.info(
`Skipping $$type because it was created before the specified start date` `Skipping this $$type because it was created before the specified start date`
); );
IssuesProcessor._endIssueProcessing(issue); IssuesProcessor._endIssueProcessing(issue);
@ -256,7 +284,7 @@ export class IssuesProcessor {
await this._removeStaleLabel(issue, staleLabel); await this._removeStaleLabel(issue, staleLabel);
} }
issueLogger.info(`Skipping $$type because it has an exempt label`); issueLogger.info(`Skipping this $$type because it has an exempt label`);
IssuesProcessor._endIssueProcessing(issue); IssuesProcessor._endIssueProcessing(issue);
continue; // Don't process exempt issues continue; // Don't process exempt issues
} }
@ -265,7 +293,11 @@ export class IssuesProcessor {
if (anyOfLabels.length > 0) { if (anyOfLabels.length > 0) {
issueLogger.info( issueLogger.info(
`The option "anyOfLabels" was specified to only processed the issues and pull requests with one of those labels (${anyOfLabels.length})` `The option ${issueLogger.createOptionLink(
Option.AnyOfLabels
)} was specified to only process the issues and pull requests with one of those labels (${chalk.cyan(
anyOfLabels.length
)})`
); );
const hasOneOfWhitelistedLabels: boolean = anyOfLabels.some( const hasOneOfWhitelistedLabels: boolean = anyOfLabels.some(
@ -292,7 +324,11 @@ export class IssuesProcessor {
); );
} }
} else { } else {
issueLogger.info(`The option "anyOfLabels" was not specified`); issueLogger.info(
`The option ${issueLogger.createOptionLink(
Option.AnyOfLabels
)} was not specified`
);
issueLogger.info( issueLogger.info(
chalk.white('└──'), chalk.white('└──'),
`Continuing the process for this $$type` `Continuing the process for this $$type`
@ -320,21 +356,45 @@ export class IssuesProcessor {
); );
// Determine if this issue needs to be marked stale first // Determine if this issue needs to be marked stale first
if (!issue.isStale && shouldBeStale && shouldMarkAsStale) { if (!issue.isStale) {
issueLogger.info( issueLogger.info(`This $$type is not stale`);
`Marking $$type stale because it was last updated on ${issue.updated_at} and it does not have a stale label` const updatedAtDate: Date = new Date(issue.updated_at);
);
await this._markStale(issue, staleMessage, staleLabel, skipMessage); if (shouldBeStale) {
issue.isStale = true; // This issue is now considered stale issueLogger.info(
} else if (!issue.isStale) { `This $$type should be stale based on the last update date the ${getHumanizedDate(
issueLogger.info( updatedAtDate
`Not marking as stale: shouldBeStale=${shouldBeStale}, shouldMarkAsStale=${shouldMarkAsStale}` )} (${chalk.cyan(issue.updated_at)})`
); );
if (shouldMarkAsStale) {
issueLogger.info(
`This $$type should be marked as stale based on the option ${issueLogger.createOptionLink(
this._getDaysBeforeStaleUsedOptionName(issue)
)} (${chalk.cyan(daysBeforeStale)})`
);
await this._markStale(issue, staleMessage, staleLabel, skipMessage);
issue.isStale = true; // This issue is now considered stale
issueLogger.info(`This $$type is now stale`);
} else {
issueLogger.info(
`This $$type should not be marked as stale based on the option ${issueLogger.createOptionLink(
this._getDaysBeforeStaleUsedOptionName(issue)
)} (${chalk.cyan(daysBeforeStale)})`
);
}
} else {
issueLogger.info(
`This $$type should not be stale based on the last update date the ${getHumanizedDate(
updatedAtDate
)} (${chalk.cyan(issue.updated_at)})`
);
}
} }
// Process the issue if it was marked stale // Process the issue if it was marked stale
if (issue.isStale) { if (issue.isStale) {
issueLogger.info(`Found a stale $$type`); issueLogger.info(`This $$type is already stale`);
await this._processStaleIssue( await this._processStaleIssue(
issue, issue,
staleLabel, staleLabel,
@ -445,7 +505,7 @@ export class IssuesProcessor {
): Promise<string | undefined> { ): Promise<string | undefined> {
const issueLogger: IssueLogger = new IssueLogger(issue); const issueLogger: IssueLogger = new IssueLogger(issue);
issueLogger.info(`Checking for label on $$type`); issueLogger.info(`Checking for label on this $$type`);
this._consumeIssueOperation(issue); this._consumeIssueOperation(issue);
this._statistics?.incrementFetchedItemsEventsCount(); this._statistics?.incrementFetchedItemsEventsCount();
@ -497,7 +557,9 @@ export class IssuesProcessor {
? this._getDaysBeforePrClose() ? this._getDaysBeforePrClose()
: this._getDaysBeforeIssueClose(); : this._getDaysBeforeIssueClose();
issueLogger.info(`Days before $$type close: ${daysBeforeClose}`); issueLogger.info(
`Days before $$type close: ${chalk.cyan(daysBeforeClose)}`
);
const issueHasUpdate: boolean = IssuesProcessor._updatedSince( const issueHasUpdate: boolean = IssuesProcessor._updatedSince(
issue.updated_at, issue.updated_at,
@ -521,13 +583,17 @@ export class IssuesProcessor {
if (!issueHasComments && !issueHasUpdate) { if (!issueHasComments && !issueHasUpdate) {
issueLogger.info( issueLogger.info(
`Closing $$type because it was last updated on ${issue.updated_at}` `Closing $$type because it was last updated on! ${chalk.cyan(
issue.updated_at
)}`
); );
await this._closeIssue(issue, closeMessage, closeLabel); await this._closeIssue(issue, closeMessage, closeLabel);
if (this.options.deleteBranch && issue.pull_request) { if (this.options.deleteBranch && issue.pull_request) {
issueLogger.info( issueLogger.info(
`Deleting branch for as delete-branch option was specified` `Deleting the branch the option ${issueLogger.createOptionLink(
Option.DeleteBranch
)} was specified`
); );
await this._deleteBranch(issue); await this._deleteBranch(issue);
this.deletedBranchIssues.push(issue); this.deletedBranchIssues.push(issue);
@ -547,7 +613,9 @@ export class IssuesProcessor {
): Promise<boolean> { ): Promise<boolean> {
const issueLogger: IssueLogger = new IssueLogger(issue); const issueLogger: IssueLogger = new IssueLogger(issue);
issueLogger.info(`Checking for comments on $$type since ${sinceDate}`); issueLogger.info(
`Checking for comments on $$type since: ${chalk.cyan(sinceDate)}`
);
if (!sinceDate) { if (!sinceDate) {
return true; return true;
@ -561,7 +629,9 @@ export class IssuesProcessor {
); );
issueLogger.info( issueLogger.info(
`Comments not made by actor or another bot: ${filteredComments.length}` `Comments not made by actor or another bot: ${chalk.cyan(
filteredComments.length
)}`
); );
// if there are any user comments returned // if there are any user comments returned
@ -577,7 +647,7 @@ export class IssuesProcessor {
): Promise<void> { ): Promise<void> {
const issueLogger: IssueLogger = new IssueLogger(issue); const issueLogger: IssueLogger = new IssueLogger(issue);
issueLogger.info(`Marking $$type as stale`); issueLogger.info(`Marking this $$type as stale`);
this.staleIssues.push(issue); this.staleIssues.push(issue);
// if the issue is being marked stale, the updated date should be changed to right now // if the issue is being marked stale, the updated date should be changed to right now
@ -712,7 +782,7 @@ export class IssuesProcessor {
if (!pullRequest) { if (!pullRequest) {
issueLogger.info( issueLogger.info(
`Not deleting branch as pull request not found for this $$type` `Not deleting this branch as no pull request was found for this $$type`
); );
return; return;
} }
@ -748,7 +818,7 @@ export class IssuesProcessor {
const issueLogger: IssueLogger = new IssueLogger(issue); const issueLogger: IssueLogger = new IssueLogger(issue);
issueLogger.info( issueLogger.info(
`Removing the label "${chalk.cyan(label)}" from the $$type...` `Removing the label "${chalk.cyan(label)}" from this $$type...`
); );
this.removedLabelIssues.push(issue); this.removedLabelIssues.push(issue);
@ -887,4 +957,31 @@ export class IssuesProcessor {
this._operations.consumeOperation(); this._operations.consumeOperation();
issue.operations.consumeOperation(); issue.operations.consumeOperation();
} }
private _getDaysBeforeStaleUsedOptionName(
issue: Readonly<Issue>
):
| Option.DaysBeforeStale
| Option.DaysBeforeIssueStale
| Option.DaysBeforePrStale {
return issue.isPullRequest
? this._getDaysBeforePrStaleUsedOptionName()
: this._getDaysBeforeIssueStaleUsedOptionName();
}
private _getDaysBeforeIssueStaleUsedOptionName():
| Option.DaysBeforeStale
| Option.DaysBeforeIssueStale {
return isNaN(this.options.daysBeforeIssueStale)
? Option.DaysBeforeStale
: Option.DaysBeforeIssueStale;
}
private _getDaysBeforePrStaleUsedOptionName():
| Option.DaysBeforeStale
| Option.DaysBeforePrStale {
return isNaN(this.options.daysBeforePrStale)
? Option.DaysBeforeStale
: Option.DaysBeforePrStale;
}
} }

2
src/classes/milestones.ts
View File

@ -34,7 +34,7 @@ export class Milestones {
if (this._shouldExemptAllMilestones()) { if (this._shouldExemptAllMilestones()) {
this._issueLogger.info( this._issueLogger.info(
chalk.white('└──'), chalk.white('└──'),
'Skipping $$type because it has a milestone' 'Skipping this $$type because it has a milestone'
); );
return true; return true;