From 32507178a3f24205bb0f785ecfafa063bd591660 Mon Sep 17 00:00:00 2001 From: Owen Voke Date: Mon, 13 Jul 2020 18:05:59 +0100 Subject: [PATCH] Add support for posting comment on closure (#99) --- __tests__/main.test.ts | 2 ++ action.yml | 4 ++++ dist/index.js | 28 +++++++++++++++++++++++----- src/IssueProcessor.ts | 32 ++++++++++++++++++++++++++++---- src/main.ts | 2 ++ 5 files changed, 59 insertions(+), 9 deletions(-) diff --git a/__tests__/main.test.ts b/__tests__/main.test.ts index 5ae9f51d..d43f6921 100644 --- a/__tests__/main.test.ts +++ b/__tests__/main.test.ts @@ -35,6 +35,8 @@ const DefaultProcessorOptions: IssueProcessorOptions = { repoToken: 'none', staleIssueMessage: 'This issue is stale', stalePrMessage: 'This PR is stale', + closeIssueMessage: 'This issue is being closed', + closePrMessage: 'This PR is being closed', daysBeforeStale: 1, daysBeforeClose: 30, staleIssueLabel: 'Stale', diff --git a/action.yml b/action.yml index bf2090c2..aae72de5 100644 --- a/action.yml +++ b/action.yml @@ -9,6 +9,10 @@ inputs: description: 'The message to post on the issue when tagging it. If none provided, will not mark issues stale.' stale-pr-message: description: 'The message to post on the pr when tagging it. If none provided, will not mark pull requests stale.' + close-issue-message: + description: 'The message to post on the issue when closing it. If none provided, will not comment when closing an issue.' + close-pr-message: + description: 'The message to post on the pr when closing it. If none provided, will not comment when closing a pull requests.' days-before-stale: description: 'The number of days old an issue can be before marking it stale.' default: 60 diff --git a/dist/index.js b/dist/index.js index 45a26533..53c24dc6 100644 --- a/dist/index.js +++ b/dist/index.js @@ -3536,6 +3536,8 @@ function getAndValidateArgs() { repoToken: core.getInput('repo-token', { required: true }), staleIssueMessage: core.getInput('stale-issue-message'), stalePrMessage: core.getInput('stale-pr-message'), + closeIssueMessage: core.getInput('close-issue-message'), + closePrMessage: core.getInput('close-pr-message'), daysBeforeStale: parseInt(core.getInput('days-before-stale', { required: true })), daysBeforeClose: parseInt(core.getInput('days-before-close', { required: true })), staleIssueLabel: core.getInput('stale-issue-label', { required: true }), @@ -3597,7 +3599,7 @@ exports.getUserAgent = getUserAgent; /***/ 215: /***/ (function(module) { -module.exports = {"_args":[["@octokit/rest@16.43.1","/Users/andymckay/c/stale"]],"_from":"@octokit/rest@16.43.1","_id":"@octokit/rest@16.43.1","_inBundle":false,"_integrity":"sha512-gfFKwRT/wFxq5qlNjnW2dh+qh74XgTQ2B179UX5K1HYCluioWj8Ndbgqw2PVqa1NnVJkGHp2ovMpVn/DImlmkw==","_location":"/@octokit/rest","_phantomChildren":{"@octokit/types":"2.8.2","deprecation":"2.3.1","once":"1.4.0"},"_requested":{"type":"version","registry":true,"raw":"@octokit/rest@16.43.1","name":"@octokit/rest","escapedName":"@octokit%2frest","scope":"@octokit","rawSpec":"16.43.1","saveSpec":null,"fetchSpec":"16.43.1"},"_requiredBy":["/","/@actions/github"],"_resolved":"https://registry.npmjs.org/@octokit/rest/-/rest-16.43.1.tgz","_spec":"16.43.1","_where":"/Users/andymckay/c/stale","author":{"name":"Gregor Martynus","url":"https://github.com/gr2m"},"bugs":{"url":"https://github.com/octokit/rest.js/issues"},"bundlesize":[{"path":"./dist/octokit-rest.min.js.gz","maxSize":"33 kB"}],"contributors":[{"name":"Mike de Boer","email":"info@mikedeboer.nl"},{"name":"Fabian Jakobs","email":"fabian@c9.io"},{"name":"Joe Gallo","email":"joe@brassafrax.com"},{"name":"Gregor Martynus","url":"https://github.com/gr2m"}],"dependencies":{"@octokit/auth-token":"^2.4.0","@octokit/plugin-paginate-rest":"^1.1.1","@octokit/plugin-request-log":"^1.0.0","@octokit/plugin-rest-endpoint-methods":"2.4.0","@octokit/request":"^5.2.0","@octokit/request-error":"^1.0.2","atob-lite":"^2.0.0","before-after-hook":"^2.0.0","btoa-lite":"^1.0.0","deprecation":"^2.0.0","lodash.get":"^4.4.2","lodash.set":"^4.3.2","lodash.uniq":"^4.5.0","octokit-pagination-methods":"^1.1.0","once":"^1.4.0","universal-user-agent":"^4.0.0"},"description":"GitHub REST API client for Node.js","devDependencies":{"@gimenete/type-writer":"^0.1.3","@octokit/auth":"^1.1.1","@octokit/fixtures-server":"^5.0.6","@octokit/graphql":"^4.2.0","@types/node":"^13.1.0","bundlesize":"^0.18.0","chai":"^4.1.2","compression-webpack-plugin":"^3.1.0","cypress":"^3.0.0","glob":"^7.1.2","http-proxy-agent":"^4.0.0","lodash.camelcase":"^4.3.0","lodash.merge":"^4.6.1","lodash.upperfirst":"^4.3.1","lolex":"^5.1.2","mkdirp":"^1.0.0","mocha":"^7.0.1","mustache":"^4.0.0","nock":"^11.3.3","npm-run-all":"^4.1.2","nyc":"^15.0.0","prettier":"^1.14.2","proxy":"^1.0.0","semantic-release":"^17.0.0","sinon":"^8.0.0","sinon-chai":"^3.0.0","sort-keys":"^4.0.0","string-to-arraybuffer":"^1.0.0","string-to-jsdoc-comment":"^1.0.0","typescript":"^3.3.1","webpack":"^4.0.0","webpack-bundle-analyzer":"^3.0.0","webpack-cli":"^3.0.0"},"files":["index.js","index.d.ts","lib","plugins"],"homepage":"https://github.com/octokit/rest.js#readme","keywords":["octokit","github","rest","api-client"],"license":"MIT","name":"@octokit/rest","nyc":{"ignore":["test"]},"publishConfig":{"access":"public"},"release":{"publish":["@semantic-release/npm",{"path":"@semantic-release/github","assets":["dist/*","!dist/*.map.gz"]}]},"repository":{"type":"git","url":"git+https://github.com/octokit/rest.js.git"},"scripts":{"build":"npm-run-all build:*","build:browser":"npm-run-all build:browser:*","build:browser:development":"webpack --mode development --entry . --output-library=Octokit --output=./dist/octokit-rest.js --profile --json > dist/bundle-stats.json","build:browser:production":"webpack --mode production --entry . --plugin=compression-webpack-plugin --output-library=Octokit --output-path=./dist --output-filename=octokit-rest.min.js --devtool source-map","build:ts":"npm run -s update-endpoints:typescript","coverage":"nyc report --reporter=html && open coverage/index.html","generate-bundle-report":"webpack-bundle-analyzer dist/bundle-stats.json --mode=static --no-open --report dist/bundle-report.html","lint":"prettier --check '{lib,plugins,scripts,test}/**/*.{js,json,ts}' 'docs/*.{js,json}' 'docs/src/**/*' index.js README.md package.json","lint:fix":"prettier --write '{lib,plugins,scripts,test}/**/*.{js,json,ts}' 'docs/*.{js,json}' 'docs/src/**/*' index.js README.md package.json","postvalidate:ts":"tsc --noEmit --target es6 test/typescript-validate.ts","prebuild:browser":"mkdirp dist/","pretest":"npm run -s lint","prevalidate:ts":"npm run -s build:ts","start-fixtures-server":"octokit-fixtures-server","test":"nyc mocha test/mocha-node-setup.js \"test/*/**/*-test.js\"","test:browser":"cypress run --browser chrome","update-endpoints":"npm-run-all update-endpoints:*","update-endpoints:fetch-json":"node scripts/update-endpoints/fetch-json","update-endpoints:typescript":"node scripts/update-endpoints/typescript","validate:ts":"tsc --target es6 --noImplicitAny index.d.ts"},"types":"index.d.ts","version":"16.43.1"}; +module.exports = {"_args":[["@octokit/rest@16.43.1","/Users/owenvoke/projects/stale"]],"_from":"@octokit/rest@16.43.1","_id":"@octokit/rest@16.43.1","_inBundle":false,"_integrity":"sha512-gfFKwRT/wFxq5qlNjnW2dh+qh74XgTQ2B179UX5K1HYCluioWj8Ndbgqw2PVqa1NnVJkGHp2ovMpVn/DImlmkw==","_location":"/@octokit/rest","_phantomChildren":{"@octokit/types":"2.8.2","deprecation":"2.3.1","once":"1.4.0"},"_requested":{"type":"version","registry":true,"raw":"@octokit/rest@16.43.1","name":"@octokit/rest","escapedName":"@octokit%2frest","scope":"@octokit","rawSpec":"16.43.1","saveSpec":null,"fetchSpec":"16.43.1"},"_requiredBy":["/","/@actions/github"],"_resolved":"https://registry.npmjs.org/@octokit/rest/-/rest-16.43.1.tgz","_spec":"16.43.1","_where":"/Users/owenvoke/projects/stale","author":{"name":"Gregor Martynus","url":"https://github.com/gr2m"},"bugs":{"url":"https://github.com/octokit/rest.js/issues"},"bundlesize":[{"path":"./dist/octokit-rest.min.js.gz","maxSize":"33 kB"}],"contributors":[{"name":"Mike de Boer","email":"info@mikedeboer.nl"},{"name":"Fabian Jakobs","email":"fabian@c9.io"},{"name":"Joe Gallo","email":"joe@brassafrax.com"},{"name":"Gregor Martynus","url":"https://github.com/gr2m"}],"dependencies":{"@octokit/auth-token":"^2.4.0","@octokit/plugin-paginate-rest":"^1.1.1","@octokit/plugin-request-log":"^1.0.0","@octokit/plugin-rest-endpoint-methods":"2.4.0","@octokit/request":"^5.2.0","@octokit/request-error":"^1.0.2","atob-lite":"^2.0.0","before-after-hook":"^2.0.0","btoa-lite":"^1.0.0","deprecation":"^2.0.0","lodash.get":"^4.4.2","lodash.set":"^4.3.2","lodash.uniq":"^4.5.0","octokit-pagination-methods":"^1.1.0","once":"^1.4.0","universal-user-agent":"^4.0.0"},"description":"GitHub REST API client for Node.js","devDependencies":{"@gimenete/type-writer":"^0.1.3","@octokit/auth":"^1.1.1","@octokit/fixtures-server":"^5.0.6","@octokit/graphql":"^4.2.0","@types/node":"^13.1.0","bundlesize":"^0.18.0","chai":"^4.1.2","compression-webpack-plugin":"^3.1.0","cypress":"^3.0.0","glob":"^7.1.2","http-proxy-agent":"^4.0.0","lodash.camelcase":"^4.3.0","lodash.merge":"^4.6.1","lodash.upperfirst":"^4.3.1","lolex":"^5.1.2","mkdirp":"^1.0.0","mocha":"^7.0.1","mustache":"^4.0.0","nock":"^11.3.3","npm-run-all":"^4.1.2","nyc":"^15.0.0","prettier":"^1.14.2","proxy":"^1.0.0","semantic-release":"^17.0.0","sinon":"^8.0.0","sinon-chai":"^3.0.0","sort-keys":"^4.0.0","string-to-arraybuffer":"^1.0.0","string-to-jsdoc-comment":"^1.0.0","typescript":"^3.3.1","webpack":"^4.0.0","webpack-bundle-analyzer":"^3.0.0","webpack-cli":"^3.0.0"},"files":["index.js","index.d.ts","lib","plugins"],"homepage":"https://github.com/octokit/rest.js#readme","keywords":["octokit","github","rest","api-client"],"license":"MIT","name":"@octokit/rest","nyc":{"ignore":["test"]},"publishConfig":{"access":"public"},"release":{"publish":["@semantic-release/npm",{"path":"@semantic-release/github","assets":["dist/*","!dist/*.map.gz"]}]},"repository":{"type":"git","url":"git+https://github.com/octokit/rest.js.git"},"scripts":{"build":"npm-run-all build:*","build:browser":"npm-run-all build:browser:*","build:browser:development":"webpack --mode development --entry . --output-library=Octokit --output=./dist/octokit-rest.js --profile --json > dist/bundle-stats.json","build:browser:production":"webpack --mode production --entry . --plugin=compression-webpack-plugin --output-library=Octokit --output-path=./dist --output-filename=octokit-rest.min.js --devtool source-map","build:ts":"npm run -s update-endpoints:typescript","coverage":"nyc report --reporter=html && open coverage/index.html","generate-bundle-report":"webpack-bundle-analyzer dist/bundle-stats.json --mode=static --no-open --report dist/bundle-report.html","lint":"prettier --check '{lib,plugins,scripts,test}/**/*.{js,json,ts}' 'docs/*.{js,json}' 'docs/src/**/*' index.js README.md package.json","lint:fix":"prettier --write '{lib,plugins,scripts,test}/**/*.{js,json,ts}' 'docs/*.{js,json}' 'docs/src/**/*' index.js README.md package.json","postvalidate:ts":"tsc --noEmit --target es6 test/typescript-validate.ts","prebuild:browser":"mkdirp dist/","pretest":"npm run -s lint","prevalidate:ts":"npm run -s build:ts","start-fixtures-server":"octokit-fixtures-server","test":"nyc mocha test/mocha-node-setup.js \"test/*/**/*-test.js\"","test:browser":"cypress run --browser chrome","update-endpoints":"npm-run-all update-endpoints:*","update-endpoints:fetch-json":"node scripts/update-endpoints/fetch-json","update-endpoints:typescript":"node scripts/update-endpoints/typescript","validate:ts":"tsc --target es6 --noImplicitAny index.d.ts"},"types":"index.d.ts","version":"16.43.1"}; /***/ }), @@ -8664,6 +8666,9 @@ class IssueProcessor { const staleMessage = isPr ? this.options.stalePrMessage : this.options.staleIssueMessage; + const closeMessage = isPr + ? this.options.closePrMessage + : this.options.closeIssueMessage; const staleLabel = isPr ? this.options.stalePrLabel : this.options.staleIssueLabel; @@ -8698,7 +8703,7 @@ class IssueProcessor { // process the issue if it was marked stale if (isStale) { core.info(`Found a stale ${issueType}`); - yield this.processStaleIssue(issue, issueType, staleLabel); + yield this.processStaleIssue(issue, issueType, staleLabel, closeMessage); } } if (this.operationsLeft <= 0) { @@ -8710,7 +8715,7 @@ class IssueProcessor { }); } // handle all of the stale issue logic when we find a stale issue - processStaleIssue(issue, issueType, staleLabel) { + processStaleIssue(issue, issueType, staleLabel, closeMessage) { return __awaiter(this, void 0, void 0, function* () { const markedStaleOn = (yield this.getLabelCreationDate(issue, staleLabel)) || issue.updated_at; core.info(`Issue #${issue.number} marked stale on: ${markedStaleOn}`); @@ -8729,7 +8734,7 @@ class IssueProcessor { } if (!issueHasComments && !issueHasUpdate) { core.info(`Closing ${issueType} because it was last updated on ${issue.updated_at}`); - yield this.closeIssue(issue); + yield this.closeIssue(issue, closeMessage); } else { core.info(`Stale ${issueType} is not old enough to close yet (hasComments? ${issueHasComments}, hasUpdate? ${issueHasUpdate}`); @@ -8830,7 +8835,7 @@ class IssueProcessor { }); } // Close an issue based on staleness - closeIssue(issue) { + closeIssue(issue, closeMessage) { return __awaiter(this, void 0, void 0, function* () { core.info(`Closing issue #${issue.number} - ${issue.title} for being stale`); this.closedIssues.push(issue); @@ -8838,6 +8843,19 @@ class IssueProcessor { if (this.options.debugOnly) { return; } + if (closeMessage) { + try { + yield this.client.issues.createComment({ + owner: github.context.repo.owner, + repo: github.context.repo.repo, + issue_number: issue.number, + body: closeMessage + }); + } + catch (error) { + core.error(`Error creating a comment: ${error.message}`); + } + } try { yield this.client.issues.update({ owner: github.context.repo.owner, diff --git a/src/IssueProcessor.ts b/src/IssueProcessor.ts index f8709c26..532ec492 100644 --- a/src/IssueProcessor.ts +++ b/src/IssueProcessor.ts @@ -37,6 +37,8 @@ export interface IssueProcessorOptions { repoToken: string; staleIssueMessage: string; stalePrMessage: string; + closeIssueMessage: string; + closePrMessage: string; daysBeforeStale: number; daysBeforeClose: number; staleIssueLabel: string; @@ -118,6 +120,9 @@ export class IssueProcessor { const staleMessage: string = isPr ? this.options.stalePrMessage : this.options.staleIssueMessage; + const closeMessage: string = isPr + ? this.options.closePrMessage + : this.options.closeIssueMessage; const staleLabel: string = isPr ? this.options.stalePrLabel : this.options.staleIssueLabel; @@ -171,7 +176,12 @@ export class IssueProcessor { // process the issue if it was marked stale if (isStale) { core.info(`Found a stale ${issueType}`); - await this.processStaleIssue(issue, issueType, staleLabel); + await this.processStaleIssue( + issue, + issueType, + staleLabel, + closeMessage + ); } } @@ -188,7 +198,8 @@ export class IssueProcessor { private async processStaleIssue( issue: Issue, issueType: string, - staleLabel: string + staleLabel: string, + closeMessage?: string ) { const markedStaleOn: string = (await this.getLabelCreationDate(issue, staleLabel)) || issue.updated_at; @@ -225,7 +236,7 @@ export class IssueProcessor { core.info( `Closing ${issueType} because it was last updated on ${issue.updated_at}` ); - await this.closeIssue(issue); + await this.closeIssue(issue, closeMessage); } else { core.info( `Stale ${issueType} is not old enough to close yet (hasComments? ${issueHasComments}, hasUpdate? ${issueHasUpdate}` @@ -349,7 +360,7 @@ export class IssueProcessor { } // Close an issue based on staleness - private async closeIssue(issue: Issue): Promise { + private async closeIssue(issue: Issue, closeMessage?: string): Promise { core.info( `Closing issue #${issue.number} - ${issue.title} for being stale` ); @@ -362,6 +373,19 @@ export class IssueProcessor { return; } + if (closeMessage) { + try { + await this.client.issues.createComment({ + owner: github.context.repo.owner, + repo: github.context.repo.repo, + issue_number: issue.number, + body: closeMessage + }); + } catch (error) { + core.error(`Error creating a comment: ${error.message}`); + } + } + try { await this.client.issues.update({ owner: github.context.repo.owner, diff --git a/src/main.ts b/src/main.ts index c7595dd7..3c391dab 100644 --- a/src/main.ts +++ b/src/main.ts @@ -18,6 +18,8 @@ function getAndValidateArgs(): IssueProcessorOptions { repoToken: core.getInput('repo-token', {required: true}), staleIssueMessage: core.getInput('stale-issue-message'), stalePrMessage: core.getInput('stale-pr-message'), + closeIssueMessage: core.getInput('close-issue-message'), + closePrMessage: core.getInput('close-pr-message'), daysBeforeStale: parseInt( core.getInput('days-before-stale', {required: true}) ),