Merge pull request #436 from peter-evans/labels-input

Add labels input

Author: peter-evans

.github/workflows/ci.yml

@@ -73,6 +73,8 @@ jobs:
         with:
           issue-number: ${{ steps.ciff.outputs.issue-number }}
           comment: '[CI] test ${{ matrix.target }}'
+          labels: |
+            wontfix
 
   package:
     if: github.event_name == 'push' && github.ref == 'refs/heads/main'

README.md

@@ -35,6 +35,19 @@ jobs:
             Auto-closing this issue.
 ```
 
+### Close issue and add label(s)
+```yml
+      - name: Close Issue
+        uses: peter-evans/close-issue@v2
+        with:
+          issue-number: 1
+          comment: Auto-closing issue
+          labels: |
+            wontfix
+```
+
+> Add multiple labels separated by comma
+
 ### Action inputs
 
 | Name | Description | Default |
@@ -44,6 +57,7 @@ jobs:
 | `issue-number` | The number of the issue to close. | `github.event.issue.number` |
 | `close-reason` | Reason for closing the issue; `completed` or `not_planned`. | `completed` |
 | `comment` | A comment to make on the issue before closing. | |
+| `labels` | A comma or newline separated list of labels. | |
 
 ### Accessing issues in other repositories
 

action.yml

@@ -20,6 +20,9 @@ inputs:
   comment:
     required: false
     description: 'A comment to make on the issue before closing'
+  labels:
+    required: false
+    description: 'A comma or newline separated list of labels.'
 runs:
   using: 'node16'
   main: 'dist/index.js'

dist/index.js

@@ -43,6 +43,15 @@ function getErrorMessage(error) {
         return error.message;
     return String(error);
 }
+function getInputAsArray(name, options) {
+    return getStringAsArray(core.getInput(name, options));
+}
+function getStringAsArray(str) {
+    return str
+        .split(/[\n,]+/)
+        .map(s => s.trim())
+        .filter(x => x !== '');
+}
 function run() {
     return __awaiter(this, void 0, void 0, function* () {
         try {
@@ -51,7 +60,8 @@ function run() {
                 repository: core.getInput('repository'),
                 issueNumber: Number(core.getInput('issue-number')),
                 closeReason: core.getInput('close-reason'),
-                comment: core.getInput('comment')
+                comment: core.getInput('comment'),
+                labels: getInputAsArray('labels')
             };
             core.debug(`Inputs: ${(0, util_1.inspect)(inputs)}`);
             const [owner, repo] = inputs.repository.split('/');
@@ -72,7 +82,8 @@ function run() {
                 repo: repo,
                 issue_number: inputs.issueNumber,
                 state: 'closed',
-                state_reason: inputs.closeReason
+                state_reason: inputs.closeReason,
+                labels: inputs.labels.length > 0 ? inputs.labels : undefined
             });
         }
         catch (error) {

src/main.ts

@@ -7,14 +7,26 @@ function getErrorMessage(error: unknown) {
   return String(error)
 }
 
+function getInputAsArray(name: string, options?: core.InputOptions): string[] {
+  return getStringAsArray(core.getInput(name, options))
+}
+
+function getStringAsArray(str: string): string[] {
+  return str
+    .split(/[\n,]+/)
+    .map(s => s.trim())
+    .filter(x => x !== '')
+}
+
 async function run(): Promise<void> {
   try {
     const inputs = {
       token: core.getInput('token'),
       repository: core.getInput('repository'),
       issueNumber: Number(core.getInput('issue-number')),
       closeReason: core.getInput('close-reason'),
-      comment: core.getInput('comment')
+      comment: core.getInput('comment'),
+      labels: getInputAsArray('labels')
     }
     core.debug(`Inputs: ${inspect(inputs)}`)
 
@@ -34,12 +46,14 @@ async function run(): Promise<void> {
     }
 
     core.info('Closing the issue as ' + inputs.closeReason)
+
     await octokit.rest.issues.update({
       owner: owner,
       repo: repo,
       issue_number: inputs.issueNumber,
       state: 'closed',
-      state_reason: inputs.closeReason
+      state_reason: inputs.closeReason,
+      labels: inputs.labels.length > 0 ? inputs.labels : undefined
     })
   } catch (error) {
     core.debug(inspect(error))