Changelog 5.1.1

* 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

.github/dependabot.yml

@@ -4,6 +4,11 @@ updates:
   - package-ecosystem: 'npm'
     # Look for `package.json` and `lock` files in the `root` directory
     directory: '/'
-    # Check the npm registry for updates every day (weekdays)
+    # Check the npm registry for updates once a week (Monday)
     schedule:
-      interval: 'daily'
+      interval: 'weekly'
+
+  - package-ecosystem: 'github-actions'
+    directory: '/'
+    schedule:
+      interval: 'weekly'

.github/workflows/check-dist.yml

@@ -21,18 +21,20 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
 
-      - name: Set Node.js 12.x
+      - name: Set Node.js 16.x
         uses: actions/setup-node@v1
         with:
-          node-version: 12.x
+          node-version: 16.x
 
       - name: Install dependencies
         run: npm ci
 
       - name: Rebuild the dist/ directory
-        run: npm run build
+        run: |
+          npm run build
+          npm run pack
 
       - name: Compare the expected and actual dist/ directories
         run: |
@@ -44,7 +46,7 @@ jobs:
         id: diff
 
       # If index.js was different than expected, upload the expected version as an artifact
-      - uses: actions/upload-artifact@v2
+      - uses: actions/upload-artifact@v3
         if: ${{ failure() && steps.diff.conclusion == 'failure' }}
         with:
           name: dist

.github/workflows/codeql.yml

@@ -13,13 +13,13 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
 
       - name: Initialize CodeQL
-        uses: github/codeql-action/init@v1
+        uses: github/codeql-action/init@v2
 
       - name: Autobuild
-        uses: github/codeql-action/autobuild@v1
+        uses: github/codeql-action/autobuild@v2
 
       - name: Perform CodeQL Analysis
-        uses: github/codeql-action/analyze@v1
+        uses: github/codeql-action/analyze@v2

.github/workflows/test.yml

@@ -10,14 +10,14 @@ jobs:
   build: # make sure build/ci work properly
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - run: |
           npm ci
           npm run all:ci
   test: # make sure the action works on a clean machine without building
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - uses: ./
         id: stale
         with:

CHANGELOG.md

@@ -1,11 +1,20 @@
 # Changelog
 
+# [5.1.1]
+
+[Fix issue when days-before-close is more than days-before-stale](https://github.com/actions/stale/pull/775)
+
+# [5.1.0]
+
+[Don't process stale issues right after they're marked stale](https://github.com/actions/stale/issues/696)
+[Add close-issue-reason option][#764](https://github.com/actions/stale/pull/764)[#772](https://github.com/actions/stale/pull/772)
+Various dependabot/dependency updates
+
 ## [4.1.0](https://github.com/actions/stale/compare/v3.0.19...v4.1.0) (2021-07-14)
 
 ## Features
 
-- [Ability to exempt draft PRs](https://github.com/actions/stale/commit/9912fa74d1c01b5d6187793d97441019cbe325d0
-)
+- [Ability to exempt draft PRs](https://github.com/actions/stale/commit/9912fa74d1c01b5d6187793d97441019cbe325d0)
 
 ## [4.0.0](https://github.com/actions/stale/compare/v3.0.19...v4.0.0) (2021-07-14)
 

CONTRIBUTING.md

@@ -46,6 +46,13 @@ Build, lint, package and test everything.
 $ npm run all
 ```
 
+IMPORTANT:
+Be sure to commit the result of:
+```bash
+$ npm run pack
+```
+Otherwise PR checks will fail. 
+
 # Release
 
 Based on [standard-version](https://github.com/conventional-changelog/standard-version).

README.md

@@ -43,6 +43,7 @@ Every argument is optional.
 | [close-pr-message](#close-pr-message)                               | Comment on the staled PRs while closed                                      |                       |
 | [stale-issue-label](#stale-issue-label)                             | Label to apply on staled issues                                             | `Stale`               |
 | [close-issue-label](#close-issue-label)                             | Label to apply on closed issues                                             |                       |
+| [close-issue-reason](#close-issue-reason)                           | Reason to use when closing issues                                           |                       |
 | [stale-pr-label](#stale-pr-label)                                   | Label to apply on staled PRs                                                | `Stale`               |
 | [close-pr-label](#close-pr-label)                                   | Label to apply on closed PRs                                                |                       |
 | [exempt-issue-labels](#exempt-issue-labels)                         | Labels on issues exempted from stale                                        |                       |
@@ -219,6 +220,12 @@ It will be automatically removed if the issues are no longer closed nor locked.
 Default value: unset  
 Required Permission: `issues: write`
 
+#### close-issue-reason
+
+Specify the [reason](https://github.blog/changelog/2022-05-19-the-new-github-issues-may-19th-update/) used when closing issues. Valid values are `completed` and `not_planned`.
+
+Default value: unset
+
 #### stale-pr-label
 
 The label that will be added to the pull requests when automatically marked as stale.  
@@ -525,7 +532,7 @@ jobs:
   stale:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/stale@v4
+      - uses: actions/stale@v5
         with:
           stale-issue-message: 'Message to comment on stale issues. If none provided, will not mark issues stale'
           stale-pr-message: 'Message to comment on stale PRs. If none provided, will not mark PRs stale'
@@ -543,7 +550,7 @@ jobs:
   stale:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/stale@v4
+      - uses: actions/stale@v5
         with:
           stale-issue-message: 'This issue is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 5 days.'
           days-before-stale: 30
@@ -562,7 +569,7 @@ jobs:
   stale:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/stale@v4
+      - uses: actions/stale@v5
         with:
           stale-issue-message: 'This issue is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 5 days.'
           stale-pr-message: 'This PR is stale because it has been open 45 days with no activity. Remove stale label or comment or this will be closed in 10 days.'
@@ -584,7 +591,7 @@ jobs:
   stale:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/stale@v4
+      - uses: actions/stale@v5
         with:
           stale-issue-message: 'This issue is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 5 days.'
           stale-pr-message: 'This PR is stale because it has been open 45 days with no activity. Remove stale label or comment or this will be closed in 10 days.'
@@ -608,7 +615,7 @@ jobs:
   stale:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/stale@v4
+      - uses: actions/stale@v5
         with:
           stale-issue-message: 'Stale issue message'
           stale-pr-message: 'Stale pull request message'
@@ -631,7 +638,7 @@ jobs:
   stale:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/stale@v4
+      - uses: actions/stale@v5
         with:
           start-date: '2020-04-18T00:00:00Z' # ISO 8601 or RFC 2822
 ```
@@ -648,7 +655,7 @@ jobs:
   stale:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/stale@v4
+      - uses: actions/stale@v5
         with:
           exempt-issue-milestones: 'future,alpha,beta'
           exempt-pr-milestones: 'bugfix,improvement'
@@ -666,7 +673,7 @@ jobs:
   stale:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/stale@v4
+      - uses: actions/stale@v5
         with:
           exempt-all-pr-milestones: true
 ```
@@ -683,7 +690,7 @@ jobs:
   stale:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/stale@v4
+      - uses: actions/stale@v5
         with:
           any-of-labels: 'needs-more-info,needs-demo'
           # You can opt for 'only-labels' instead if your use-case requires all labels
@@ -702,7 +709,7 @@ jobs:
   stale:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/stale@v4
+      - uses: actions/stale@v5
         with:
           exempt-issue-assignees: 'marco,polo'
           exempt-pr-assignees: 'marco'
@@ -720,7 +727,7 @@ jobs:
   stale:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/stale@v4
+      - uses: actions/stale@v5
         with:
           exempt-all-pr-assignees: true
 ```

__tests__/any-of-labels.spec.ts

@@ -1103,7 +1103,7 @@ class IssuesProcessorBuilder {
           issue.updated_at ?? new Date().toDateString(),
           issue.created_at ?? new Date().toDateString(),
           !!issue.pull_request,
-          issue.labels ? issue.labels.map(label => label.name) : []
+          issue.labels ? issue.labels.map(label => label.name || '') : []
         )
     );
 

__tests__/classes/issues-processor-mock.ts

@@ -9,7 +9,7 @@ export class IssuesProcessorMock extends IssuesProcessor {
     options: IIssuesProcessorOptions,
     getIssues?: (page: number) => Promise<Issue[]>,
     listIssueComments?: (
-      issueNumber: number,
+      issue: Issue,
       sinceDate: string
     ) => Promise<IComment[]>,
     getLabelCreationDate?: (

__tests__/constants/default-processor-options.ts

@@ -50,5 +50,6 @@ export const DefaultProcessorOptions: IIssuesProcessorOptions = Object.freeze({
   ignoreUpdates: false,
   ignoreIssueUpdates: undefined,
   ignorePrUpdates: undefined,
-  exemptDraftPr: false
+  exemptDraftPr: false,
+  closeIssueReason: ''
 });

__tests__/exempt-draft-pr.spec.ts

@@ -85,7 +85,7 @@ class IssuesProcessorBuilder {
           issue.updated_at ?? new Date().toDateString(),
           issue.created_at ?? new Date().toDateString(),
           !!issue.pull_request,
-          issue.labels ? issue.labels.map(label => label.name) : []
+          issue.labels ? issue.labels.map(label => label.name || '') : []
         )
     );
 

__tests__/only-labels.spec.ts

@@ -1103,7 +1103,7 @@ class IssuesProcessorBuilder {
           issue.updated_at ?? new Date().toDateString(),
           issue.created_at ?? new Date().toDateString(),
           !!issue.pull_request,
-          issue.labels ? issue.labels.map(label => label.name) : []
+          issue.labels ? issue.labels.map(label => label.name || '') : []
         )
     );
 

__tests__/remove-stale-when-updated.spec.ts

@@ -455,7 +455,7 @@ class IssuesProcessorBuilder {
           issue.updated_at ?? new Date().toDateString(),
           issue.created_at ?? new Date().toDateString(),
           !!issue.pull_request,
-          issue.labels ? issue.labels.map(label => label.name) : []
+          issue.labels ? issue.labels.map(label => label.name || '') : []
         )
     );
 

action.yml

@@ -49,6 +49,10 @@ inputs:
     description: 'The labels that mean an issue is exempt from being marked stale. Separate multiple labels with commas (eg. "label1,label2").'
     default: ''
     required: false
+  close-issue-reason:
+    description: 'The reason to use when closing an issue.'
+    default: ''
+    required: false
   stale-pr-label:
     description: 'The label to apply when a pull request is stale.'
     default: 'Stale'
@@ -198,5 +202,5 @@ outputs:
   staled-issues-prs:
     description: 'List of all staled issues and pull requests.'
 runs:
-  using: 'node12'
+  using: 'node16'
   main: 'dist/index.js'

package.json

@@ -39,7 +39,7 @@
   "license": "MIT",
   "dependencies": {
     "@actions/core": "^1.2.6",
-    "@actions/github": "^4.0.0",
+    "@actions/github": "^5.0.1",
     "lodash.deburr": "^4.1.0",
     "semver": "^7.3.5"
   },
@@ -54,15 +54,15 @@
     "ansi-styles": "5.2.0",
     "eslint": "^7.28.0",
     "eslint-plugin-github": "^4.1.2",
-    "eslint-plugin-jest": "^24.4.2",
+    "eslint-plugin-jest": "^25.3.2",
     "jest": "^27.2.5",
-    "jest-circus": "^27.2.0",
+    "jest-circus": "^27.4.6",
     "jest-silent-reporter": "^0.5.0",
     "js-yaml": "^4.1.0",
-    "prettier": "^2.4.1",
+    "prettier": "^2.5.1",
     "standard-version": "^9.3.1",
     "terminal-link": "^2.1.1",
-    "ts-jest": "^27.0.5",
+    "ts-jest": "^27.1.2",
     "typescript": "^4.3.2"
   }
 }

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/issue.ts

@@ -1,7 +1,7 @@
 import {isLabeled} from '../functions/is-labeled';
 import {isPullRequest} from '../functions/is-pull-request';
 import {Assignee} from '../interfaces/assignee';
-import {IIssue} from '../interfaces/issue';
+import {IIssue, OctokitIssue} from '../interfaces/issue';
 import {IIssuesProcessorOptions} from '../interfaces/issues-processor-options';
 import {ILabel} from '../interfaces/label';
 import {IMilestone} from '../interfaces/milestone';
@@ -17,28 +17,30 @@ export class Issue implements IIssue {
   readonly pull_request: Object | null | undefined;
   readonly state: string | 'closed' | 'open';
   readonly locked: boolean;
-  readonly milestone: IMilestone | undefined;
+  readonly milestone?: IMilestone | null;
   readonly assignees: Assignee[];
   isStale: boolean;
+  markedStaleThisRun: boolean;
   operations = new Operations();
   private readonly _options: IIssuesProcessorOptions;
 
   constructor(
     options: Readonly<IIssuesProcessorOptions>,
-    issue: Readonly<IIssue>
+    issue: Readonly<OctokitIssue> | Readonly<IIssue>
   ) {
     this._options = options;
     this.title = issue.title;
     this.number = issue.number;
     this.created_at = issue.created_at;
     this.updated_at = issue.updated_at;
-    this.labels = issue.labels;
+    this.labels = mapLabels(issue.labels);
     this.pull_request = issue.pull_request;
     this.state = issue.state;
     this.locked = issue.locked;
     this.milestone = issue.milestone;
-    this.assignees = issue.assignees;
+    this.assignees = issue.assignees || [];
     this.isStale = isLabeled(this, this.staleLabel);
+    this.markedStaleThisRun = false;
   }
 
   get isPullRequest(): boolean {
@@ -59,3 +61,14 @@ export class Issue implements IIssue {
       : this._options.staleIssueLabel;
   }
 }
+
+function mapLabels(labels: (string | ILabel)[] | ILabel[]): ILabel[] {
+  return labels.map(label => {
+    if (typeof label == 'string') {
+      return {
+        name: label
+      };
+    }
+    return label;
+  });
+}

src/classes/issues-processor.ts

@@ -1,7 +1,6 @@
 import * as core from '@actions/core';
 import {context, getOctokit} from '@actions/github';
 import {GitHub} from '@actions/github/lib/utils';
-import {GetResponseTypeFromEndpointMethod} from '@octokit/types';
 import {Option} from '../enums/option';
 import {getHumanizedDate} from '../functions/dates/get-humanized-date';
 import {isDateMoreRecentThan} from '../functions/dates/is-date-more-recent-than';
@@ -25,7 +24,7 @@ import {Milestones} from './milestones';
 import {StaleOperations} from './stale-operations';
 import {Statistics} from './statistics';
 import {LoggerService} from '../services/logger.service';
-import {IIssue} from '../interfaces/issue';
+import {OctokitIssue} from '../interfaces/issue';
 
 /***
  * Handle processing of issues for staleness/closure.
@@ -466,6 +465,7 @@ export class IssuesProcessor {
           );
           await this._markStale(issue, staleMessage, staleLabel, skipMessage);
           issue.isStale = true; // This issue is now considered stale
+          issue.markedStaleThisRun = true;
           issueLogger.info(`This $$type is now stale`);
         } else {
           issueLogger.info(
@@ -510,17 +510,17 @@ export class IssuesProcessor {
 
   // Grab comments for an issue since a given date
   async listIssueComments(
-    issueNumber: Readonly<number>,
+    issue: Readonly<Issue>,
     sinceDate: Readonly<string>
   ): Promise<IComment[]> {
     // Find any comments since date on the given issue
     try {
-      this.operations.consumeOperation();
+      this._consumeIssueOperation(issue);
       this.statistics?.incrementFetchedItemsCommentsCount();
-      const comments = await this.client.issues.listComments({
+      const comments = await this.client.rest.issues.listComments({
         owner: context.repo.owner,
         repo: context.repo.repo,
-        issue_number: issueNumber,
+        issue_number: issue.number,
         since: sinceDate
       });
       return comments.data;
@@ -532,14 +532,9 @@ export class IssuesProcessor {
 
   // grab issues from github in batches of 100
   async getIssues(page: number): Promise<Issue[]> {
-    // generate type for response
-    const endpoint = this.client.issues.listForRepo;
-    type OctoKitIssueList = GetResponseTypeFromEndpointMethod<typeof endpoint>;
-
     try {
       this.operations.consumeOperation();
-      const issueResult: OctoKitIssueList =
-        await this.client.issues.listForRepo({
+      const issueResult = await this.client.rest.issues.listForRepo({
         owner: context.repo.owner,
         repo: context.repo.repo,
         state: 'open',
@@ -550,7 +545,7 @@ export class IssuesProcessor {
       this.statistics?.incrementFetchedItemsCount(issueResult.data.length);
 
       return issueResult.data.map(
-        (issue: Readonly<IIssue>): Issue => new Issue(this.options, issue)
+        (issue: Readonly<OctokitIssue>): Issue => new Issue(this.options, issue)
       );
     } catch (error) {
       this._logger.error(`Get issues for repo error: ${error.message}`);
@@ -570,7 +565,7 @@ export class IssuesProcessor {
 
     this._consumeIssueOperation(issue);
     this.statistics?.incrementFetchedItemsEventsCount();
-    const options = this.client.issues.listEvents.endpoint.merge({
+    const options = this.client.rest.issues.listEvents.endpoint.merge({
       owner: context.repo.owner,
       repo: context.repo.repo,
       per_page: 100,
@@ -601,7 +596,7 @@ export class IssuesProcessor {
       this._consumeIssueOperation(issue);
       this.statistics?.incrementFetchedPullRequestsCount();
 
-      const pullRequest = await this.client.pulls.get({
+      const pullRequest = await this.client.rest.pulls.get({
         owner: context.repo.owner,
         repo: context.repo.repo,
         pull_number: issue.number
@@ -630,13 +625,15 @@ export class IssuesProcessor {
       `$$type marked stale on: ${LoggerService.cyan(markedStaleOn)}`
     );
 
-    const issueHasComments: boolean = await this._hasCommentsSince(
+    const issueHasCommentsSinceStale: boolean = await this._hasCommentsSince(
       issue,
       markedStaleOn,
       staleMessage
     );
     issueLogger.info(
-      `$$type has been commented on: ${LoggerService.cyan(issueHasComments)}`
+      `$$type has been commented on: ${LoggerService.cyan(
+        issueHasCommentsSinceStale
+      )}`
     );
 
     const daysBeforeClose: number = issue.isPullRequest
@@ -647,14 +644,6 @@ export class IssuesProcessor {
       `Days before $$type close: ${LoggerService.cyan(daysBeforeClose)}`
     );
 
-    const issueHasUpdate: boolean = IssuesProcessor._updatedSince(
-      issue.updated_at,
-      daysBeforeClose
-    );
-    issueLogger.info(
-      `$$type has been updated: ${LoggerService.cyan(issueHasUpdate)}`
-    );
-
     const shouldRemoveStaleWhenUpdated: boolean =
       this._shouldRemoveStaleWhenUpdated(issue);
 
@@ -672,10 +661,27 @@ export class IssuesProcessor {
       );
     }
 
-    // Should we un-stale this issue?
-    if (shouldRemoveStaleWhenUpdated && issueHasComments) {
+    if (issue.markedStaleThisRun) {
+      issueLogger.info(`marked stale this run, so don't check for updates`);
+    }
+
+    const issueHasUpdateSinceStale =
+      new Date(issue.updated_at) > new Date(markedStaleOn);
+
     issueLogger.info(
-        `Remove the stale label since the $$type has a comment and the workflow should remove the stale label when updated`
+      `$$type has been updated since it was marked stale: ${LoggerService.cyan(
+        issueHasUpdateSinceStale
+      )}`
+    );
+
+    // Should we un-stale this issue?
+    if (
+      shouldRemoveStaleWhenUpdated &&
+      (issueHasUpdateSinceStale || issueHasCommentsSinceStale) &&
+      !issue.markedStaleThisRun
+    ) {
+      issueLogger.info(
+        `Remove the stale label since the $$type has been updated and the workflow should remove the stale label when updated`
       );
       await this._removeStaleLabel(issue, staleLabel);
 
@@ -693,7 +699,17 @@ export class IssuesProcessor {
       return; // Nothing to do because we aren't closing stale issues
     }
 
-    if (!issueHasComments && !issueHasUpdate) {
+    const issueHasUpdateInCloseWindow: boolean = IssuesProcessor._updatedSince(
+      issue.updated_at,
+      daysBeforeClose
+    );
+    issueLogger.info(
+      `$$type has been updated in the last ${daysBeforeClose} days: ${LoggerService.cyan(
+        issueHasUpdateInCloseWindow
+      )}`
+    );
+
+    if (!issueHasCommentsSinceStale && !issueHasUpdateInCloseWindow) {
       issueLogger.info(
         `Closing $$type because it was last updated on: ${LoggerService.cyan(
           issue.updated_at
@@ -712,7 +728,7 @@ export class IssuesProcessor {
       }
     } else {
       issueLogger.info(
-        `Stale $$type is not old enough to close yet (hasComments? ${issueHasComments}, hasUpdate? ${issueHasUpdate})`
+        `Stale $$type is not old enough to close yet (hasComments? ${issueHasCommentsSinceStale}, hasUpdate? ${issueHasUpdateInCloseWindow})`
       );
     }
   }
@@ -734,12 +750,12 @@ export class IssuesProcessor {
     }
 
     // find any comments since the date
-    const comments = await this.listIssueComments(issue.number, sinceDate);
+    const comments = await this.listIssueComments(issue, sinceDate);
 
     const filteredComments = comments.filter(
       comment =>
-        comment.user.type === 'User' &&
-        comment.body.toLowerCase() !== staleMessage.toLowerCase()
+        comment.user?.type === 'User' &&
+        comment.body?.toLowerCase() !== staleMessage.toLowerCase()
     );
 
     issueLogger.info(
@@ -775,7 +791,7 @@ export class IssuesProcessor {
         this.statistics?.incrementAddedItemsComment(issue);
 
         if (!this.options.debugOnly) {
-          await this.client.issues.createComment({
+          await this.client.rest.issues.createComment({
             owner: context.repo.owner,
             repo: context.repo.repo,
             issue_number: issue.number,
@@ -793,7 +809,7 @@ export class IssuesProcessor {
       this.statistics?.incrementStaleItemsCount(issue);
 
       if (!this.options.debugOnly) {
-        await this.client.issues.addLabels({
+        await this.client.rest.issues.addLabels({
           owner: context.repo.owner,
           repo: context.repo.repo,
           issue_number: issue.number,
@@ -823,7 +839,7 @@ export class IssuesProcessor {
         this.addedCloseCommentIssues.push(issue);
 
         if (!this.options.debugOnly) {
-          await this.client.issues.createComment({
+          await this.client.rest.issues.createComment({
             owner: context.repo.owner,
             repo: context.repo.repo,
             issue_number: issue.number,
@@ -841,7 +857,7 @@ export class IssuesProcessor {
         this.statistics?.incrementAddedItemsLabel(issue);
 
         if (!this.options.debugOnly) {
-          await this.client.issues.addLabels({
+          await this.client.rest.issues.addLabels({
             owner: context.repo.owner,
             repo: context.repo.repo,
             issue_number: issue.number,
@@ -858,11 +874,12 @@ export class IssuesProcessor {
       this.statistics?.incrementClosedItemsCount(issue);
 
       if (!this.options.debugOnly) {
-        await this.client.issues.update({
+        await this.client.rest.issues.update({
           owner: context.repo.owner,
           repo: context.repo.repo,
           issue_number: issue.number,
-          state: 'closed'
+          state: 'closed',
+          state_reason: this.options.closeIssueReason || undefined
         });
       }
     } catch (error) {
@@ -900,7 +917,7 @@ export class IssuesProcessor {
       this.statistics?.incrementDeletedBranchesCount();
 
       if (!this.options.debugOnly) {
-        await this.client.git.deleteRef({
+        await this.client.rest.git.deleteRef({
           owner: context.repo.owner,
           repo: context.repo.repo,
           ref: `heads/${branch}`
@@ -935,7 +952,7 @@ export class IssuesProcessor {
       this.statistics?.incrementDeletedItemsLabelsCount(issue);
 
       if (!this.options.debugOnly) {
-        await this.client.issues.removeLabel({
+        await this.client.rest.issues.removeLabel({
           owner: context.repo.owner,
           repo: context.repo.repo,
           issue_number: issue.number,
@@ -1065,10 +1082,10 @@ export class IssuesProcessor {
     this.addedLabelIssues.push(issue);
 
     try {
-      this.operations.consumeOperation();
+      this._consumeIssueOperation(issue);
       this.statistics?.incrementAddedItemsLabel(issue);
       if (!this.options.debugOnly) {
-        await this.client.issues.addLabels({
+        await this.client.rest.issues.addLabels({
           owner: context.repo.owner,
           repo: context.repo.repo,
           issue_number: issue.number,

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/functions/clean-label.ts

@@ -9,6 +9,6 @@ import {CleanLabel} from '../types/clean-label';
  *
  * @return {string} A lowercased, deburred version of the passed in label
  */
-export function cleanLabel(label: Readonly<string>): CleanLabel {
-  return deburr(label.toLowerCase());
+export function cleanLabel(label?: Readonly<string>): CleanLabel {
+  return deburr(label?.toLowerCase());
 }

src/interfaces/comment.ts

@@ -1,6 +1,6 @@
 import {IUser} from './user';
 
 export interface IComment {
-  user: IUser;
-  body: string;
+  user: IUser | null;
+  body?: string;
 }

src/interfaces/issue.ts

@@ -2,16 +2,18 @@ import {IsoDateString} from '../types/iso-date-string';
 import {Assignee} from './assignee';
 import {ILabel} from './label';
 import {IMilestone} from './milestone';
-
+import {components} from '@octokit/openapi-types';
 export interface IIssue {
   title: string;
   number: number;
   created_at: IsoDateString;
   updated_at: IsoDateString;
   labels: ILabel[];
-  pull_request: Object | null | undefined;
+  pull_request?: Object | null;
   state: string;
   locked: boolean;
-  milestone: IMilestone | undefined;
-  assignees: Assignee[];
+  milestone?: IMilestone | null;
+  assignees?: Assignee[] | null;
 }
+
+export type OctokitIssue = components['schemas']['issue'];

src/interfaces/issues-processor-options.ts

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

src/interfaces/label.ts

@@ -1,3 +1,3 @@
 export interface ILabel {
-  name: string;
+  name?: string;
 }

src/interfaces/pull-request.ts

@@ -3,5 +3,5 @@ export interface IPullRequest {
   head: {
     ref: string;
   };
-  draft: boolean;
+  draft?: boolean;
 }

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;
 }