feat(prs): add new input pull-request-remove-labels-after-close

When closing a pull request, you can now remove some extra labels. This might specifically handy if you want to remove the stale label to "clean" the closed pull request. Closes #859.
Sonia-corporation · Sep 4, 2022 · 87e990b · 87e990b
1 parent 7d8e170
commit 87e990b
Show file tree

Hide file tree

Showing 22 changed files with 1,001 additions and 83 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -214,6 +214,8 @@ To help us have a clear vision over the workflow and also for you if you are jus
         - When the input value is not empty, add a comment
       - Check if the action should also add extra labels (coming from the `pull-request-add-labels-after-close` input)
         - When the input value is filled list, add the listed labels
+      - Check if the action should also remove extra labels (coming from the `pull-request-remove-labels-after-close` input)
+        - When the input value is filled list, remove the listed labels
       - Check if the action should also delete the branch (coming from the `pull-request-delete-branch-after-close` input)
         - When the input value is true, delete the branch
 - Check if the pull request last update is older than X days (coming from the `pull-request-days-before-stale`)

diff --git a/README.md b/README.md
@@ -175,6 +175,7 @@ All the inputs that are used both for issues and pull requests.
 | [pull-request-add-labels-after-stale](https://sonia-stale-action.vercel.app/docs/pull-requests/inputs/pull-request-add-labels-after-stale-input)           | A list of labels added when the processing stale the pull request (multiline).                                                                         |         |
 | [pull-request-remove-labels-after-stale](https://sonia-stale-action.vercel.app/docs/pull-requests/inputs/pull-request-remove-labels-after-stale-input)     | A list of labels removed when the processing stale the pull request (multiline).                                                                       |         |
 | [pull-request-add-labels-after-close](https://sonia-stale-action.vercel.app/docs/pull-requests/inputs/pull-request-add-labels-after-close-input)           | A list of labels added when the processing close the pull request (multiline).                                                                         |         |
+| [pull-request-remove-labels-after-close](https://sonia-stale-action.vercel.app/docs/pull-requests/inputs/pull-request-remove-labels-after-close-input)     | A list of labels removed when the processing close the pull request (multiline).                                                                       |         |
 | [pull-request-to-draft-instead-of-stale](https://sonia-stale-action.vercel.app/docs/pull-requests/inputs/pull-request-to-draft-instead-of-stale-input)     | Convert the pull request to a draft pull request instead of handling it as a stale candidate.                                                          | `false` |
 | [pull-request-delete-branch-after-close](https://sonia-stale-action.vercel.app/docs/pull-requests/inputs/pull-request-delete-branch-after-close-input)     | Delete the branch when the processing close the pull request.                                                                                          | `false` |
 

diff --git a/action.yml b/action.yml
@@ -249,6 +249,10 @@ inputs:
     description: 'A list of labels added when the processing close the pull request (multiline).'
     required: false
     default: ''
+  pull-request-remove-labels-after-close:
+    description: 'A list of labels removed when the processing close the pull request (multiline).'
+    required: false
+    default: ''
   pull-request-to-draft-instead-of-stale:
     description: 'Convert the pull request to a draft pull request instead of handling it as a stale candidate.'
     required: false

diff --git a/dist/index.js b/dist/index.js
diff --git a/documentation/docs/03-all-inputs.mdx b/documentation/docs/03-all-inputs.mdx
@@ -81,5 +81,6 @@ The list of all the inputs.
 | [pull-request-add-labels-after-stale](pull-requests/inputs/pull-request-add-labels-after-stale-input)           | A list of labels added when the processing stale the pull request (multiline).                                                                         |                       |
 | [pull-request-remove-labels-after-stale](pull-requests/inputs/pull-request-remove-labels-after-stale-input)     | A list of labels removed when the processing stale the pull request (multiline).                                                                       |                       |
 | [pull-request-add-labels-after-close](pull-requests/inputs/pull-request-add-labels-after-close-input)           | A list of labels added when the processing close the pull request (multiline).                                                                         |                       |
+| [pull-request-remove-labels-after-close](pull-requests/inputs/pull-request-remove-labels-after-close-input)     | A list of labels removed when the processing close the pull request (multiline).                                                                       |                       |
 | [pull-request-to-draft-instead-of-stale](pull-requests/inputs/pull-request-to-draft-instead-of-stale-input)     | Convert the pull request to a draft pull request instead of handling it as a stale candidate.                                                          | `false`               |
 | [pull-request-delete-branch-after-close](pull-requests/inputs/pull-request-delete-branch-after-close-input)     | Delete the branch when the processing close the pull request.                                                                                          | `false`               |
diff --git a/documentation/docs/08-pull-requests/01-inputs/01-all-inputs.mdx b/documentation/docs/08-pull-requests/01-inputs/01-all-inputs.mdx
@@ -47,5 +47,6 @@ The list of all the pull requests inputs.
 | [pull-request-add-labels-after-stale](pull-request-add-labels-after-stale-input)           | A list of labels added when the processing stale the pull request (multiline).                                                                         |         |
 | [pull-request-remove-labels-after-stale](pull-request-remove-labels-after-stale-input)     | A list of labels removed when the processing stale the pull request (multiline).                                                                       |         |
 | [pull-request-add-labels-after-close](pull-request-add-labels-after-close-input)           | A list of labels added when the processing close the pull request (multiline).                                                                         |         |
+| [pull-request-remove-labels-after-close](pull-request-remove-labels-after-close-input)     | A list of labels removed when the processing close the pull request (multiline).                                                                       |         |
 | [pull-request-to-draft-instead-of-stale](pull-request-to-draft-instead-of-stale-input)     | Convert the pull request to a draft pull request instead of handling it as a stale candidate.                                                          | `false` |
 | [pull-request-delete-branch-after-close](pull-request-delete-branch-after-close-input)     | Delete the branch when the processing close the pull request.                                                                                          | `false` |
diff --git a/documentation/docs/08-pull-requests/01-inputs/41-close-comment-input.mdx b/documentation/docs/08-pull-requests/01-inputs/41-close-comment-input.mdx
@@ -24,7 +24,8 @@ This can be useful if you wish to improve the communication and the process on h
 
 :::note
 
-You can also add labels onto it by using the [add labels after close input](pull-request-add-labels-after-close-input)
+You can also add labels onto it by using the [add labels after close input](pull-request-add-labels-after-close-input),
+remove labels onto it by using the [remove labels after close input](pull-request-remove-labels-after-close-input)
 and define the number of days before closing it by using the [days before close input](pull-request-days-before-close-input).
 
 :::

diff --git a/documentation/docs/08-pull-requests/01-inputs/51-days-before-close-input.mdx b/documentation/docs/08-pull-requests/01-inputs/51-days-before-close-input.mdx
@@ -29,7 +29,8 @@ The pull request will be closed tomorrow if no update occur until then.
 
 :::info
 
-You can also add labels onto it by using the [add labels after close input](pull-request-add-labels-after-close-input)
+You can also add labels onto it by using the [add labels after close input](pull-request-add-labels-after-close-input),
+remove labels onto it by using the [remove labels after close input](pull-request-remove-labels-after-close-input)
 and add a comment to explain why it was closed by using the [close comment input](pull-request-close-comment-input).
 
 :::

diff --git a/documentation/docs/08-pull-requests/01-inputs/73-add-labels-after-close-input.mdx b/documentation/docs/08-pull-requests/01-inputs/73-add-labels-after-close-input.mdx
@@ -31,7 +31,8 @@ If not, the GitHub API will throw an error.
 
 :::info
 
-You can also add a comment to explain why it was closed by using the [close comment input](pull-request-close-comment-input)
+You can also add a comment to explain why it was closed by using the [close comment input](pull-request-close-comment-input),
+remove labels onto it by using the [remove labels after close input](pull-request-remove-labels-after-close-input)
 and define the number of days before closing it by using the [days before close input](pull-request-days-before-close-input).
 
 :::

diff --git a/...entation/docs/08-pull-requests/01-inputs/74-remove-labels-after-close-input.mdx b/...entation/docs/08-pull-requests/01-inputs/74-remove-labels-after-close-input.mdx
@@ -0,0 +1,51 @@
+---
+id: pull-request-remove-labels-after-close-input
+title: Remove pull request labels after close input
+description: |
+  All the information you need to know about the remove pull request labels after close input.
+  Including a detailed description and an example.
+tags:
+  - Pull requests
+  - Inputs
+  - Labels
+  - Closing
+---
+
+### Input {#input}
+
+Name: `pull-request-remove-labels-after-close`  
+Type: `string[]`  
+Default value: `[]`
+
+### Description {#description}
+
+This input will let you remove extra labels when the processing close the pull requests.  
+This can be useful if you wish to easily remove extra labels to improve your triage post-closing.
+
+:::caution
+
+The labels must be real labels, existing inside your repository list of labels (_github.com/your-organization/your-repository/labels_).  
+If not, the GitHub API will throw an error.
+
+:::
+
+:::info
+
+You can also add a comment to explain why it was closed by using the [close comment input](pull-request-close-comment-input),
+add labels onto it by using the [add labels after close input](pull-request-add-labels-after-close-input)
+and define the number of days before closing it by using the [days before close input](pull-request-days-before-close-input).
+
+:::
+
+### Example {#example}
+
+```yml {6-8}
+# ...
+name: Stale
+id: stale
+uses: sonia-corporation/stale@latest
+with:
+  pull-request-remove-labels-after-close: |
+    new author feedback
+    closing soon!
+```
diff --git a/...ts/74-to-draft-instead-of-stale-input.mdx → ...ts/75-to-draft-instead-of-stale-input.mdx b/...ts/74-to-draft-instead-of-stale-input.mdx → ...ts/75-to-draft-instead-of-stale-input.mdx
diff --git a/...ts/75-delete-branch-after-close-input.mdx → ...ts/76-delete-branch-after-close-input.mdx b/...ts/75-delete-branch-after-close-input.mdx → ...ts/76-delete-branch-after-close-input.mdx
diff --git a/src/core/inputs/inputs.enum.ts b/src/core/inputs/inputs.enum.ts
@@ -32,6 +32,7 @@ export enum EInputs {
   PULL_REQUEST_ADD_LABELS_AFTER_CLOSE = `pull-request-add-labels-after-close`,
   PULL_REQUEST_ADD_LABELS_AFTER_STALE = `pull-request-add-labels-after-stale`,
   PULL_REQUEST_REMOVE_LABELS_AFTER_STALE = `pull-request-remove-labels-after-stale`,
+  PULL_REQUEST_REMOVE_LABELS_AFTER_CLOSE = `pull-request-remove-labels-after-close`,
   PULL_REQUEST_CLOSE_COMMENT = `pull-request-close-comment`,
   PULL_REQUEST_DAYS_BEFORE_CLOSE = `pull-request-days-before-close`,
   PULL_REQUEST_DAYS_BEFORE_STALE = `pull-request-days-before-stale`,

diff --git a/src/core/inputs/interfaces/pull-requests-inputs.interface.ts b/src/core/inputs/interfaces/pull-requests-inputs.interface.ts
@@ -28,6 +28,7 @@ export interface IPullRequestsInputs extends IInputs {
   readonly pullRequestOnlyWithMilestones: boolean;
   readonly pullRequestOnlyWithProjectCards: boolean;
   readonly pullRequestProcessing: boolean;
+  readonly pullRequestRemoveLabelsAfterClose: string[];
   readonly pullRequestRemoveLabelsAfterStale: string[];
   readonly pullRequestStaleComment: IComment | '';
   readonly pullRequestStaleLabel: string;