Add close-issue-reason option (#764)

* Add close-as-not-planned option

* update readme

* add to Option enum

* improve wording

* npm run pack

* updates from review

* fix tests and improve error message

* fix readme order

src/classes/issue.spec.ts

@@ -61,7 +61,8 @@ describe('Issue', (): void => {
       ignoreUpdates: false,
       ignoreIssueUpdates: undefined,
       ignorePrUpdates: undefined,
-      exemptDraftPr: false
+      exemptDraftPr: false,
+      closeIssueReason: ''
     };
     issueInterface = {
       title: 'dummy-title',

src/classes/issues-processor.ts

@@ -865,7 +865,8 @@ export class IssuesProcessor {
           owner: context.repo.owner,
           repo: context.repo.repo,
           issue_number: issue.number,
-          state: 'closed'
+          state: 'closed',
+          state_reason: this.options.closeIssueReason || undefined
         });
       }
     } catch (error) {

src/enums/option.ts

@@ -46,5 +46,6 @@ export enum Option {
   IgnoreUpdates = 'ignore-updates',
   IgnoreIssueUpdates = 'ignore-issue-updates',
   IgnorePrUpdates = 'ignore-pr-updates',
-  ExemptDraftPr = 'exempt-draft-pr'
+  ExemptDraftPr = 'exempt-draft-pr',
+  CloseIssueReason = 'close-issue-reason'
 }

src/interfaces/issues-processor-options.ts

@@ -51,4 +51,5 @@ export interface IIssuesProcessorOptions {
   ignoreIssueUpdates: boolean | undefined;
   ignorePrUpdates: boolean | undefined;
   exemptDraftPr: boolean;
+  closeIssueReason: string;
 }

src/main.ts

@@ -87,7 +87,8 @@ function _getAndValidateArgs(): IIssuesProcessorOptions {
     ignoreUpdates: core.getInput('ignore-updates') === 'true',
     ignoreIssueUpdates: _toOptionalBoolean('ignore-issue-updates'),
     ignorePrUpdates: _toOptionalBoolean('ignore-pr-updates'),
-    exemptDraftPr: core.getInput('exempt-draft-pr') === 'true'
+    exemptDraftPr: core.getInput('exempt-draft-pr') === 'true',
+    closeIssueReason: core.getInput('close-issue-reason')
   };
 
   for (const numberInput of [
@@ -113,6 +114,15 @@ function _getAndValidateArgs(): IIssuesProcessorOptions {
     }
   }
 
+  const validCloseReasons = ['', 'completed', 'not_planned'];
+  if (!validCloseReasons.includes(args.closeIssueReason)) {
+    const errorMessage = `Unrecognized close-issue-reason "${
+      args.closeIssueReason
+    }", valid values are: ${validCloseReasons.filter(Boolean).join(', ')}`;
+    core.setFailed(errorMessage);
+    throw new Error(errorMessage);
+  }
+
   return args;
 }