Update to latest actions and octokit libraries (#124)

Upgrade to latest libraries but use "any" for the client until I figure out how to use the right type

.eslintrc.json

@@ -1,6 +1,6 @@
 {
     "plugins": ["jest", "@typescript-eslint"],
-    "extends": ["plugin:github/es6"],
+    "extends": ["plugin:github/recommended"],
     "parser": "@typescript-eslint/parser",
     "parserOptions": {
       "ecmaVersion": 9,
@@ -16,11 +16,10 @@
       "@typescript-eslint/no-require-imports": "error",
       "@typescript-eslint/array-type": "error",
       "@typescript-eslint/await-thenable": "error",
-      "@typescript-eslint/ban-ts-ignore": "error",
+      "@typescript-eslint/ban-ts-comment": "error",
       "camelcase": "off",
-      "@typescript-eslint/class-name-casing": "error",
+      "@typescript-eslint/consistent-type-assertions": "error",
       "@typescript-eslint/func-call-spacing": ["error", "never"],
-      "@typescript-eslint/generic-type-naming": ["error", "^[A-Z][A-Za-z]*$"],
       "@typescript-eslint/no-array-constructor": "error",
       "@typescript-eslint/no-empty-interface": "error",
       "@typescript-eslint/no-explicit-any": "off",
@@ -30,7 +29,6 @@
       "@typescript-eslint/no-misused-new": "error",
       "@typescript-eslint/no-namespace": "error",
       "@typescript-eslint/no-non-null-assertion": "warn",
-      "@typescript-eslint/no-object-literal-type-assertion": "error",
       "@typescript-eslint/no-unnecessary-qualifier": "error",
       "@typescript-eslint/no-unnecessary-type-assertion": "error",
       "@typescript-eslint/no-useless-constructor": "error",
@@ -38,7 +36,6 @@
       "@typescript-eslint/prefer-for-of": "warn",
       "@typescript-eslint/prefer-function-type": "warn",
       "@typescript-eslint/prefer-includes": "error",
-      "@typescript-eslint/prefer-interface": "error",
       "@typescript-eslint/prefer-string-starts-ends-with": "error",
       "@typescript-eslint/promise-function-async": "error",
       "@typescript-eslint/require-array-sort-compare": "error",

.github/dependabot.yml

@@ -0,0 +1,9 @@
+version: 2
+updates:
+  # Enable version updates for npm
+  - package-ecosystem: 'npm'
+    # Look for `package.json` and `lock` files in the `root` directory
+    directory: '/'
+    # Check the npm registry for updates every day (weekdays)
+    schedule:
+      interval: 'daily'

.github/workflows/test.yml

@@ -3,7 +3,7 @@ on: # rebuild any PRs and main branch changes
   pull_request:
   push:
     branches:
-      - master
+      - main
       - 'releases/*'
 
 jobs:

__tests__/main.test.ts

@@ -47,7 +47,9 @@ const DefaultProcessorOptions: IssueProcessorOptions = Object.freeze({
   operationsPerRun: 100,
   debugOnly: true,
   removeStaleWhenUpdated: false,
-  ascending: false
+  ascending: false,
+  skipStaleIssueMessage: false,
+  skipStalePrMessage: false
 });
 
 test('empty issue list results in 1 operation', async () => {
@@ -737,3 +739,157 @@ test('stale issues should not be closed until after the closed number of days (l
   expect(processor.removedLabelIssues.length).toEqual(0);
   expect(processor.staleIssues.length).toEqual(1);
 });
+
+test('skips stale message on issues when skip-stale-issue-message is set', async () => {
+  let lastUpdate = new Date();
+  lastUpdate.setDate(lastUpdate.getDate() - 10);
+  const TestIssueList: Issue[] = [
+    generateIssue(
+      1,
+      'An issue that should be marked stale but not closed',
+      lastUpdate.toString(),
+      false
+    )
+  ];
+
+  const opts = {...DefaultProcessorOptions};
+  opts.daysBeforeStale = 5; // stale after 5 days
+  opts.daysBeforeClose = 20; // closes after 25 days
+  opts.skipStaleIssueMessage = true;
+
+  const processor = new IssueProcessor(
+    opts,
+    async p => (p == 1 ? TestIssueList : []),
+    async (num, dt) => [],
+    async (issue, label) => new Date().toDateString()
+  );
+
+  // for sake of testing, mocking private function
+  const markSpy = jest.spyOn(processor as any, 'markStale');
+
+  await processor.processIssues(1);
+
+  // issue should be staled
+  expect(processor.closedIssues.length).toEqual(0);
+  expect(processor.removedLabelIssues.length).toEqual(0);
+  expect(processor.staleIssues.length).toEqual(1);
+
+  // comment should not be created
+  expect(markSpy).toHaveBeenCalledWith(
+    TestIssueList[0],
+    opts.staleIssueMessage,
+    opts.staleIssueLabel,
+    // this option is skipMessage
+    true
+  );
+});
+
+test('skips stale message on prs when skip-stale-pr-message is set', async () => {
+  let lastUpdate = new Date();
+  lastUpdate.setDate(lastUpdate.getDate() - 10);
+  const TestIssueList: Issue[] = [
+    generateIssue(
+      1,
+      'An issue that should be marked stale but not closed',
+      lastUpdate.toString(),
+      true
+    )
+  ];
+
+  const opts = {...DefaultProcessorOptions};
+  opts.daysBeforeStale = 5; // stale after 5 days
+  opts.daysBeforeClose = 20; // closes after 25 days
+  opts.skipStalePrMessage = true;
+
+  const processor = new IssueProcessor(
+    opts,
+    async p => (p == 1 ? TestIssueList : []),
+    async (num, dt) => [],
+    async (issue, label) => new Date().toDateString()
+  );
+
+  // for sake of testing, mocking private function
+  const markSpy = jest.spyOn(processor as any, 'markStale');
+
+  await processor.processIssues(1);
+
+  // issue should be staled
+  expect(processor.closedIssues.length).toEqual(0);
+  expect(processor.removedLabelIssues.length).toEqual(0);
+  expect(processor.staleIssues.length).toEqual(1);
+
+  // comment should not be created
+  expect(markSpy).toHaveBeenCalledWith(
+    TestIssueList[0],
+    opts.stalePrMessage,
+    opts.stalePrLabel,
+    // this option is skipMessage
+    true
+  );
+});
+
+test('not providing state takes precedence over skipStaleIssueMessage', async () => {
+  let lastUpdate = new Date();
+  lastUpdate.setDate(lastUpdate.getDate() - 10);
+  const TestIssueList: Issue[] = [
+    generateIssue(
+      1,
+      'An issue that should be marked stale but not closed',
+      lastUpdate.toString(),
+      false
+    )
+  ];
+
+  const opts = {...DefaultProcessorOptions};
+  opts.daysBeforeStale = 5; // stale after 5 days
+  opts.daysBeforeClose = 20; // closes after 25 days
+  opts.skipStalePrMessage = true;
+  opts.staleIssueMessage = '';
+
+  const processor = new IssueProcessor(
+    opts,
+    async p => (p == 1 ? TestIssueList : []),
+    async (num, dt) => [],
+    async (issue, label) => new Date().toDateString()
+  );
+
+  await processor.processIssues(1);
+
+  // issue should be staled
+  expect(processor.closedIssues.length).toEqual(0);
+  expect(processor.removedLabelIssues.length).toEqual(0);
+  expect(processor.staleIssues.length).toEqual(0);
+});
+
+test('not providing stalePrMessage takes precedence over skipStalePrMessage', async () => {
+  let lastUpdate = new Date();
+  lastUpdate.setDate(lastUpdate.getDate() - 10);
+  const TestIssueList: Issue[] = [
+    generateIssue(
+      1,
+      'An issue that should be marked stale but not closed',
+      lastUpdate.toString(),
+      true
+    )
+  ];
+
+  const opts = {...DefaultProcessorOptions};
+  opts.daysBeforeStale = 5; // stale after 5 days
+  opts.daysBeforeClose = 20; // closes after 25 days
+  opts.skipStalePrMessage = true;
+  opts.stalePrMessage = '';
+
+  const processor = new IssueProcessor(
+    opts,
+    async p => (p == 1 ? TestIssueList : []),
+    async (num, dt) => [],
+    async (issue, label) => new Date().toDateString()
+  );
+
+  await processor.processIssues(1);
+
+  // issue should be staled
+  expect(processor.closedIssues.length).toEqual(0);
+  expect(processor.removedLabelIssues.length).toEqual(0);
+  expect(processor.staleIssues.length).toEqual(0);
+});

action.yml

@@ -46,6 +46,12 @@ inputs:
   ascending:
     description: 'The order to get issues or pull requests. Defaults to false, which is descending'
     default: false
+  skip-stale-pr-message:
+    description: 'Skip adding stale message when marking a pull request as stale.'
+    default: false
+  skip-stale-issue-message:
+    description: 'Skip adding stale message when marking an issue as stale.'
+    default: false
 runs:
   using: 'node12'
   main: 'dist/index.js'

package.json

@@ -26,24 +26,24 @@
   "license": "MIT",
   "dependencies": {
     "@actions/core": "^1.2.4",
-    "@actions/github": "^2.2.0",
+    "@actions/github": "^4.0.0",
-    "@octokit/rest": "^16.43.1",
+    "@octokit/rest": "^18.0.2",
-    "semver": "^6.1.1"
+    "semver": "^7.3.2"
   },
   "devDependencies": {
-    "@types/semver": "^6.0.0",
+    "@types/semver": "^7.3.1",
-    "@types/jest": "^24.0.23",
+    "@types/jest": "^26.0.5",
-    "@types/node": "^12.7.12",
+    "@types/node": "^14.0.25",
-    "@typescript-eslint/parser": "^2.8.0",
+    "@typescript-eslint/parser": "^3.7.0",
     "@zeit/ncc": "^0.20.5",
     "eslint": "^5.16.0",
-    "eslint-plugin-github": "^2.0.0",
+    "eslint-plugin-github": "^4.0.1",
-    "eslint-plugin-jest": "^22.21.0",
+    "eslint-plugin-jest": "^23.18.0",
     "jest": "^24.9.0",
-    "jest-circus": "^24.9.0",
+    "jest-circus": "^26.1.0",
     "js-yaml": "^3.13.1",
     "prettier": "^1.19.1",
     "ts-jest": "^24.2.0",
-    "typescript": "^3.6.4"
+    "typescript": "^3.9.7"
   }
 }

src/IssueProcessor.ts

@@ -1,8 +1,6 @@
 import * as core from '@actions/core';
-import * as github from '@actions/github';
+import {context, getOctokit} from '@actions/github';
-import {Octokit} from '@octokit/rest';
+import {GetResponseTypeFromEndpointMethod} from '@octokit/types';
-
-type OctoKitIssueList = Octokit.Response<Octokit.IssuesListForRepoResponse>;
 
 export interface Issue {
   title: string;
@@ -50,15 +48,17 @@ export interface IssueProcessorOptions {
   removeStaleWhenUpdated: boolean;
   debugOnly: boolean;
   ascending: boolean;
+  skipStaleIssueMessage: boolean;
+  skipStalePrMessage: boolean;
 }
 
 /***
  * Handle processing of issues for staleness/closure.
  */
 export class IssueProcessor {
-  readonly client: github.GitHub;
+  readonly client: any; // need to make this the correct type
   readonly options: IssueProcessorOptions;
-  private operationsLeft: number = 0;
+  private operationsLeft = 0;
 
   readonly staleIssues: Issue[] = [];
   readonly closedIssues: Issue[] = [];
@@ -78,7 +78,7 @@ export class IssueProcessor {
   ) {
     this.options = options;
     this.operationsLeft = options.operationsPerRun;
-    this.client = new github.GitHub(options.repoToken);
+    this.client = getOctokit(options.repoToken);
 
     if (getIssues) {
       this.getIssues = getIssues;
@@ -99,7 +99,7 @@ export class IssueProcessor {
     }
   }
 
-  async processIssues(page: number = 1): Promise<number> {
+  async processIssues(page = 1): Promise<number> {
     // get the next batch of issues
     const issues: Issue[] = await this.getIssues(page);
     this.operationsLeft -= 1;
@@ -129,6 +129,9 @@ export class IssueProcessor {
       const exemptLabels = IssueProcessor.parseCommaSeparatedString(
         isPr ? this.options.exemptPrLabels : this.options.exemptIssueLabels
       );
+      const skipMessage = isPr
+        ? this.options.skipStalePrMessage
+        : this.options.skipStaleIssueMessage;
       const issueType: string = isPr ? 'pr' : 'issue';
       const shouldMarkWhenStale = this.options.daysBeforeStale > -1;
 
@@ -170,7 +173,7 @@ export class IssueProcessor {
         core.info(
           `Marking ${issueType} stale because it was last updated on ${issue.updated_at} and it does not have a stale label`
         );
-        await this.markStale(issue, staleMessage, staleLabel);
+        await this.markStale(issue, staleMessage, staleLabel, skipMessage);
         isStale = true; // this issue is now considered stale
       }
 
@@ -263,12 +266,11 @@ export class IssueProcessor {
 
     const filteredComments = comments.filter(
       comment =>
-        comment.user.type === 'User' &&
+        comment.user.type === 'User' && comment.user.login !== context.actor
-        comment.user.login !== github.context.actor
     );
 
     core.info(
-      `Comments not made by ${github.context.actor} or another bot: ${filteredComments.length}`
+      `Comments not made by ${context.actor} or another bot: ${filteredComments.length}`
     );
 
     // if there are any user comments returned
@@ -283,8 +285,8 @@ export class IssueProcessor {
     // find any comments since date on the given issue
     try {
       const comments = await this.client.issues.listComments({
-        owner: github.context.repo.owner,
+        owner: context.repo.owner,
-        repo: github.context.repo.repo,
+        repo: context.repo.repo,
         issue_number: issueNumber,
         since: sinceDate
       });
@@ -297,11 +299,15 @@ export class IssueProcessor {
 
   // grab issues from github in baches of 100
   private async getIssues(page: number): Promise<Issue[]> {
+    // generate type for response
+    const endpoint = this.client.issues.listForRepo;
+    type OctoKitIssueList = GetResponseTypeFromEndpointMethod<typeof endpoint>;
+
     try {
       const issueResult: OctoKitIssueList = await this.client.issues.listForRepo(
         {
-          owner: github.context.repo.owner,
+          owner: context.repo.owner,
-          repo: github.context.repo.repo,
+          repo: context.repo.repo,
           state: 'open',
           labels: this.options.onlyLabels,
           per_page: 100,
@@ -320,7 +326,8 @@ export class IssueProcessor {
   private async markStale(
     issue: Issue,
     staleMessage: string,
-    staleLabel: string
+    staleLabel: string,
+    skipMessage: boolean
   ): Promise<void> {
     core.info(`Marking issue #${issue.number} - ${issue.title} as stale`);
 
@@ -337,21 +344,23 @@ export class IssueProcessor {
       return;
     }
 
-    try {
+    if (!skipMessage) {
-      await this.client.issues.createComment({
+      try {
-        owner: github.context.repo.owner,
+        await this.client.issues.createComment({
-        repo: github.context.repo.repo,
+          owner: context.repo.owner,
-        issue_number: issue.number,
+          repo: context.repo.repo,
-        body: staleMessage
+          issue_number: issue.number,
-      });
+          body: staleMessage
-    } catch (error) {
+        });
-      core.error(`Error creating a comment: ${error.message}`);
+      } catch (error) {
+        core.error(`Error creating a comment: ${error.message}`);
+      }
     }
 
     try {
       await this.client.issues.addLabels({
-        owner: github.context.repo.owner,
+        owner: context.repo.owner,
-        repo: github.context.repo.repo,
+        repo: context.repo.repo,
         issue_number: issue.number,
         labels: [staleLabel]
       });
@@ -377,8 +386,8 @@ export class IssueProcessor {
     if (closeMessage) {
       try {
         await this.client.issues.createComment({
-          owner: github.context.repo.owner,
+          owner: context.repo.owner,
-          repo: github.context.repo.repo,
+          repo: context.repo.repo,
           issue_number: issue.number,
           body: closeMessage
         });
@@ -389,8 +398,8 @@ export class IssueProcessor {
 
     try {
       await this.client.issues.update({
-        owner: github.context.repo.owner,
+        owner: context.repo.owner,
-        repo: github.context.repo.repo,
+        repo: context.repo.repo,
         issue_number: issue.number,
         state: 'closed'
       });
@@ -415,8 +424,8 @@ export class IssueProcessor {
 
     try {
       await this.client.issues.removeLabel({
-        owner: github.context.repo.owner,
+        owner: context.repo.owner,
-        repo: github.context.repo.repo,
+        repo: context.repo.repo,
         issue_number: issue.number,
         name: encodeURIComponent(label) // A label can have a "?" in the name
       });
@@ -436,8 +445,8 @@ export class IssueProcessor {
     this.operationsLeft -= 1;
 
     const options = this.client.issues.listEvents.endpoint.merge({
-      owner: github.context.repo.owner,
+      owner: context.repo.owner,
-      repo: github.context.repo.repo,
+      repo: context.repo.repo,
       per_page: 100,
       issue_number: issue.number
     });

src/main.ts

@@ -38,7 +38,9 @@ function getAndValidateArgs(): IssueProcessorOptions {
       core.getInput('remove-stale-when-updated') === 'false'
     ),
     debugOnly: core.getInput('debug-only') === 'true',
-    ascending: core.getInput('ascending') === 'true'
+    ascending: core.getInput('ascending') === 'true',
+    skipStalePrMessage: core.getInput('skip-stale-pr-message') === 'true',
+    skipStaleIssueMessage: core.getInput('skip-stale-issue-message') === 'true'
   };
 
   for (const numberInput of [