Merge pull request #205 from actions/users/tihuang/untrustedinputs

Not print untrusted info to STDOUT.

README.md

@@ -18,6 +18,31 @@ Run the tests :heavy_check_mark:
 ```bash
 $ npm test
 ```
+### Arguments
+
+| Input  | Description | Usage |
+| :---:     |     :---:   |    :---:   |
+| `repo-token`  | PAT(Personal Access Token) for authorizing repository. | *Required* |
+| `days-before-stale`  | Idle number of days before marking an issue/pr as stale. *Defaults to **60*** | Optional
+| `days-before-close`  | Idle number of days before closing an stale issue/pr. *Defaults to **7*** | Optional
+| `stale-issue-message`  | Message to post on the stale issue. | Optional
+| `stale-pr-message`  | Message to post on the stale pr. | Optional
+| `close-issue-message` | Message to post on the stale issue while closing it. | Optional
+| `close-pr-message`  | Message to post on the stale pr while closing it. | Optional
+| `stale-issue-label`  | Label to apply on the stale issue. *Defaults to **stale*** | Optional
+| `close-issue-label` | Label to apply on closing issue. | Optional
+| `stale-pr-label` | Label to apply on the stale pr. | Optional
+| `close-pr-label` | Label to apply on the closing pr. | Optional
+| `exempt-issue-labels` | Labels on an issue exempted from being marked as stale. | Optional
+| `exempt-pr-labels` | Labels on the pr exempted from being marked as stale. | Optional
+| `only-labels` | Only labels checked for stale issue/pr. | Optional
+| `operations-per-run` | Maximum number of operations per run. *Defaults to **30*** | Optional
+| `remove-stale-when-updated` | Remove stale label from issue/pr on updates or comments. *Defaults to **true*** | Optional
+| `debug-only` | Dry-run on action. *Defaults to **false*** | Optional
+| `ascending` | Order to get issues/pr. *Defaults to **false*** | Optional
+| `skip-stale-issue-message` | Skip adding stale message on stale issue. *Defaults to **false*** | Optional
+| `skip-stale-pr-message` | Skip adding stale message on stale pr. *Defaults to **false*** | Optional
+
 
 ### Usage
 
@@ -28,7 +53,7 @@ Basic:
 name: "Close stale issues"
 on:
   schedule:
-  - cron: "0 0 * * *"
+  - cron: "30 1 * * *"
 
 jobs:
   stale:
@@ -46,7 +71,7 @@ Configure stale timeouts:
 name: "Close stale issues"
 on:
   schedule:
-  - cron: "0 0 * * *"
+  - cron: "30 1 * * *"
 
 jobs:
   stale:
@@ -65,7 +90,7 @@ Configure labels:
 name: "Close stale issues"
 on:
   schedule:
-  - cron: "0 0 * * *"
+  - cron: "30 1 * * *"
 
 jobs:
   stale:

__tests__/main.test.ts

@@ -40,8 +40,10 @@ const DefaultProcessorOptions: IssueProcessorOptions = Object.freeze({
   daysBeforeStale: 1,
   daysBeforeClose: 30,
   staleIssueLabel: 'Stale',
+  closeIssueLabel: '',
   exemptIssueLabels: '',
   stalePrLabel: 'Stale',
+  closePrLabel: '',
   exemptPrLabels: '',
   onlyLabels: '',
   operationsPerRun: 100,

action.yml

@@ -22,12 +22,16 @@ inputs:
   stale-issue-label:
     description: 'The label to apply when an issue is stale.'
     default: 'Stale'
+  close-issue-label:
+    description: 'The label to apply when an issue is closed.'
   exempt-issue-labels:
     description: 'The labels to apply when an issue is exempt from being marked stale. Separate multiple labels with commas (eg. "label1,label2")'
     default: ''
   stale-pr-label:
     description: 'The label to apply when a pull request is stale.'
     default: 'Stale'
+  close-pr-label:
+    description: 'The label to apply when a pull request is closed.'
   exempt-pr-labels:
     description: 'The labels to apply when a pull request is exempt from being marked stale. Separate multiple labels with commas (eg. "label1,label2")'
     default: ''
@@ -52,9 +56,6 @@ inputs:
   skip-stale-issue-message:
     description: 'Skip adding stale message when marking an issue as stale.'
     default: false
-  process-drafts:
-    description: 'Should the draft PRs be marked stale? If set to true, draft PRs will be included in processing.'
-    default: false
 runs:
   using: 'node12'
   main: 'dist/index.js'

package.json

@@ -25,7 +25,7 @@
   "author": "GitHub",
   "license": "MIT",
   "dependencies": {
-    "@actions/core": "^1.2.4",
+    "@actions/core": "^1.2.6",
     "@actions/github": "^4.0.0",
     "@octokit/rest": "^18.0.4",
     "semver": "^7.3.2"
@@ -33,16 +33,16 @@
   "devDependencies": {
     "@types/semver": "^7.3.1",
     "@types/jest": "^26.0.10",
-    "@types/node": "^14.6.0",
+    "@types/node": "^14.10.0",
     "@typescript-eslint/parser": "^3.10.1",
-    "@vercel/ncc": "^0.23.0",
+    "@vercel/ncc": "^0.24.0",
     "eslint": "^7.7.0",
     "eslint-plugin-github": "^4.0.1",
     "eslint-plugin-jest": "^23.20.0",
     "jest": "^24.9.0",
-    "jest-circus": "^26.1.0",
+    "jest-circus": "^26.4.2",
     "js-yaml": "^3.14.0",
-    "prettier": "^2.0.5",
+    "prettier": "^2.1.1",
     "ts-jest": "^24.2.0",
     "typescript": "^4.0.2"
   }

src/IssueProcessor.ts

@@ -10,7 +10,6 @@ export interface Issue {
   pull_request: any;
   state: string;
   locked: boolean;
-  draft: boolean;
 }
 
 export interface User {
@@ -41,8 +40,10 @@ export interface IssueProcessorOptions {
   daysBeforeStale: number;
   daysBeforeClose: number;
   staleIssueLabel: string;
+  closeIssueLabel: string;
   exemptIssueLabels: string;
   stalePrLabel: string;
+  closePrLabel: string;
   exemptPrLabels: string;
   onlyLabels: string;
   operationsPerRun: number;
@@ -51,7 +52,6 @@ export interface IssueProcessorOptions {
   ascending: boolean;
   skipStaleIssueMessage: boolean;
   skipStalePrMessage: boolean;
-  processDrafts: boolean;
 }
 
 /***
@@ -115,7 +115,7 @@ export class IssueProcessor {
       const isPr = !!issue.pull_request;
 
       core.info(
-        `Found issue: issue #${issue.number} - ${issue.title} last updated ${issue.updated_at} (is pr? ${isPr})`
+        `Found issue: issue #${issue.number} last updated ${issue.updated_at} (is pr? ${isPr})`
       );
 
       // calculate string based messages for this issue
@@ -128,6 +128,9 @@ export class IssueProcessor {
       const staleLabel: string = isPr
         ? this.options.stalePrLabel
         : this.options.staleIssueLabel;
+      const closeLabel: string = isPr
+        ? this.options.closePrLabel
+        : this.options.closeIssueLabel;
       const exemptLabels = IssueProcessor.parseCommaSeparatedString(
         isPr ? this.options.exemptPrLabels : this.options.exemptIssueLabels
       );
@@ -152,11 +155,6 @@ export class IssueProcessor {
         continue; // don't process locked issues
       }
 
-      if (issue.draft && !this.options.processDrafts) {
-        core.info(`Skipping ${issueType} because it is a draft`);
-        continue; // don't process drafts
-      }
-
       if (
         exemptLabels.some((exemptLabel: string) =>
           IssueProcessor.isLabeled(issue, exemptLabel)
@@ -191,7 +189,8 @@ export class IssueProcessor {
           issue,
           issueType,
           staleLabel,
-          closeMessage
+          closeMessage,
+          closeLabel
         );
       }
     }
@@ -210,7 +209,8 @@ export class IssueProcessor {
     issue: Issue,
     issueType: string,
     staleLabel: string,
-    closeMessage?: string
+    closeMessage?: string,
+    closeLabel?: string
   ) {
     const markedStaleOn: string =
       (await this.getLabelCreationDate(issue, staleLabel)) || issue.updated_at;
@@ -247,7 +247,7 @@ export class IssueProcessor {
       core.info(
         `Closing ${issueType} because it was last updated on ${issue.updated_at}`
       );
-      await this.closeIssue(issue, closeMessage);
+      await this.closeIssue(issue, closeMessage, closeLabel);
     } else {
       core.info(
         `Stale ${issueType} is not old enough to close yet (hasComments? ${issueHasComments}, hasUpdate? ${issueHasUpdate}`
@@ -277,7 +277,7 @@ export class IssueProcessor {
     );
 
     core.info(
-      `Comments not made by ${context.actor} or another bot: ${filteredComments.length}`
+      `Comments not made by actor or another bot: ${filteredComments.length}`
     );
 
     // if there are any user comments returned
@@ -322,8 +322,6 @@ export class IssueProcessor {
           page
         }
       );
-
-      core.info(`issue data: ${JSON.stringify(issueResult.data)}`);
       return issueResult.data;
     } catch (error) {
       core.error(`Get issues for repo error: ${error.message}`);
@@ -338,7 +336,7 @@ export class IssueProcessor {
     staleLabel: string,
     skipMessage: boolean
   ): Promise<void> {
-    core.info(`Marking issue #${issue.number} - ${issue.title} as stale`);
+    core.info(`Marking issue #${issue.number} as stale`);
 
     this.staleIssues.push(issue);
 
@@ -379,10 +377,12 @@ export class IssueProcessor {
   }
 
   // Close an issue based on staleness
-  private async closeIssue(issue: Issue, closeMessage?: string): Promise<void> {
-    core.info(
-      `Closing issue #${issue.number} - ${issue.title} for being stale`
-    );
+  private async closeIssue(
+    issue: Issue,
+    closeMessage?: string,
+    closeLabel?: string
+  ): Promise<void> {
+    core.info(`Closing issue #${issue.number} for being stale`);
 
     this.closedIssues.push(issue);
 
@@ -405,6 +405,19 @@ export class IssueProcessor {
       }
     }
 
+    if (closeLabel) {
+      try {
+        await this.client.issues.addLabels({
+          owner: context.repo.owner,
+          repo: context.repo.repo,
+          issue_number: issue.number,
+          labels: [closeLabel]
+        });
+      } catch (error) {
+        core.error(`Error adding a label: ${error.message}`);
+      }
+    }
+
     try {
       await this.client.issues.update({
         owner: context.repo.owner,
@@ -419,9 +432,7 @@ export class IssueProcessor {
 
   // Remove a label from an issue
   private async removeLabel(issue: Issue, label: string): Promise<void> {
-    core.info(
-      `Removing label ${label} from issue #${issue.number} - ${issue.title}`
-    );
+    core.info(`Removing label from issue #${issue.number}`);
 
     this.removedLabelIssues.push(issue);
 
@@ -449,7 +460,7 @@ export class IssueProcessor {
     issue: Issue,
     label: string
   ): Promise<string | undefined> {
-    core.info(`Checking for label ${label} on issue #${issue.number}`);
+    core.info(`Checking for label on issue #${issue.number}`);
 
     this.operationsLeft -= 1;
 

src/main.ts

@@ -27,8 +27,10 @@ function getAndValidateArgs(): IssueProcessorOptions {
       core.getInput('days-before-close', {required: true})
     ),
     staleIssueLabel: core.getInput('stale-issue-label', {required: true}),
+    closeIssueLabel: core.getInput('close-issue-label'),
     exemptIssueLabels: core.getInput('exempt-issue-labels'),
     stalePrLabel: core.getInput('stale-pr-label', {required: true}),
+    closePrLabel: core.getInput('close-pr-label'),
     exemptPrLabels: core.getInput('exempt-pr-labels'),
     onlyLabels: core.getInput('only-labels'),
     operationsPerRun: parseInt(
@@ -40,8 +42,7 @@ function getAndValidateArgs(): IssueProcessorOptions {
     debugOnly: core.getInput('debug-only') === 'true',
     ascending: core.getInput('ascending') === 'true',
     skipStalePrMessage: core.getInput('skip-stale-pr-message') === 'true',
-    skipStaleIssueMessage: core.getInput('skip-stale-issue-message') === 'true',
-    processDrafts: core.getInput('process-drafts') === 'true'
+    skipStaleIssueMessage: core.getInput('skip-stale-issue-message') === 'true'
   };
 
   for (const numberInput of [