feat(milestone): add new input pull-request-only-any-milestones

This new input will let you process only the pull requests that contains one of the specified milestone. Closes #518
Sonia-corporation · Feb 20, 2022 · 7a1197e · 7a1197e
1 parent 41f4f0d
commit 7a1197e
Show file tree

Hide file tree

Showing 21 changed files with 562 additions and 64 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -174,6 +174,7 @@ To help us have a clear vision over the workflow and also for you if you are jus
 - Check if the pull request creation date is before x date and stop the processing if this is the case (coming from the `pull-request-ignore-before-creation-date` input)
 - Check if the pull request is a draft and stop the processing if this is the case (coming from the `pull-request-ignore-draft` input)
 - Check if the input `pull-request-only-any-project-cards` contains some project cards. If this is the case and the pull request has at least one project card matching linked to it, the processing will continue, else the processing will stop.
+- Check if the input `pull-request-only-any-milestones` contains some milestones. If this is the case and the pull request has at least one milestone matching linked to it, the processing will continue, else the processing will stop.
 - Check if the pull request has already a stale state (stale label)
   - If the pull request has a stale label, check if it was updated after the addition of the stale label
     - If it was updated, remove the stale state (stale label) and stop the processing

diff --git a/README.md b/README.md
@@ -139,6 +139,7 @@ All the inputs that are used both for issues and pull requests.
 | [pull-request-limit-api-queries-count](https://sonia-corporation.github.io/stale/docs/pull-requests/inputs/pull-request-limit-api-queries-count-input)         | Limit the quantity of API queries calls performed during the processing of pull requests (-1 for unlimited).                                           | `-1`    |
 | [pull-request-limit-api-mutations-count](https://sonia-corporation.github.io/stale/docs/pull-requests/inputs/pull-request-limit-api-mutations-count-input)     | Limit the quantity of API mutations calls performed during the processing of pull requests (-1 for unlimited).                                         | `-1`    |
 | [pull-request-only-any-project-cards](https://sonia-corporation.github.io/stale/docs/pull-requests/inputs/pull-request-only-any-project-cards-input)           | Only allow the processing of pull requests that contains one of those project cards (multiline).                                                       |         |
+| [pull-request-only-any-milestones](https://sonia-corporation.github.io/stale/docs/pull-requests/inputs/pull-request-only-any-milestones-input)                 | Only allow the processing of pull requests that contains one of those milestones (multiline).                                                          |         |
 
 ## All the pull requests outputs
 

diff --git a/action.yml b/action.yml
@@ -165,6 +165,10 @@ inputs:
     description: 'Only allow the processing of pull requests that contains one of those project cards (multiline).'
     required: false
     default: ''
+  pull-request-only-any-milestones:
+    description: 'Only allow the processing of pull requests that contains one of those milestones (multiline).'
+    required: false
+    default: ''
 outputs:
   # Issues outputs
   processed-issues-count:

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
@@ -55,3 +55,4 @@ The list of all the inputs.
 | [pull-request-limit-api-queries-count](pull-requests/inputs/pull-request-limit-api-queries-count-input)         | Limit the quantity of API queries calls performed during the processing of pull requests (-1 for unlimited).                                           | `-1`                  |
 | [pull-request-limit-api-mutations-count](pull-requests/inputs/pull-request-limit-api-mutations-count-input)     | Limit the quantity of API mutations calls performed during the processing of pull requests (-1 for unlimited).                                         | `-1`                  |
 | [pull-request-only-any-project-cards](pull-requests/inputs/pull-request-only-any-project-cards-input)           | Only allow the processing of pull requests that contains one of those project cards (multiline).                                                       |                       |
+| [pull-request-only-any-milestones](pull-requests/inputs/pull-request-only-any-milestones-input)                 | Only allow the processing of pull requests that contains one of those milestones (multiline).                                                          |                       |
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
@@ -32,3 +32,4 @@ The list of all the pull requests inputs.
 | [pull-request-limit-api-queries-count](pull-request-limit-api-queries-count-input)         | Limit the quantity of API queries calls performed during the processing of pull requests (-1 for unlimited).                                           | `-1`    |
 | [pull-request-limit-api-mutations-count](pull-request-limit-api-mutations-count-input)     | Limit the quantity of API mutations calls performed during the processing of pull requests (-1 for unlimited).                                         | `-1`    |
 | [pull-request-only-any-project-cards](pull-request-only-any-project-cards-input)           | Only allow the processing of pull requests that contains one of those project cards (multiline).                                                       |         |
+| [pull-request-only-any-milestones](pull-request-only-any-milestones-input)                 | Only allow the processing of pull requests that contains one of those milestones (multiline).                                                          |         |
diff --git a/documentation/docs/08-pull-requests/01-inputs/22-only-any-project-cards-input.mdx b/documentation/docs/08-pull-requests/01-inputs/22-only-any-project-cards-input.mdx
@@ -2,8 +2,8 @@
 id: pull-request-only-any-project-cards-input
 title: Pull request only any project cards input
 description: |
-  All the information you need to know about the pull request only any project cards input.
-  Including a detailed description and an example.
+All the information you need to know about the pull request only any project cards input.
+Including a detailed description and an example.
 tags:
   - Pull requests
   - Inputs

diff --git a/documentation/docs/08-pull-requests/01-inputs/23-only-any-milestones-input.mdx b/documentation/docs/08-pull-requests/01-inputs/23-only-any-milestones-input.mdx
@@ -0,0 +1,35 @@
+---
+id: pull-request-only-any-milestones-input
+title: Pull request only any milestones input
+description: |
+All the information you need to know about the pull request only any milestones input.
+Including a detailed description and an example.
+tags:
+  - Pull requests
+  - Inputs
+  - Milestones
+---
+
+### Input {#input}
+
+Name: `pull-request-only-any-milestones`  
+Type: `string[]`  
+Default value: `[]`
+
+### Description {#description}
+
+This input will let you process only the pull requests that are linked to a milestone which is white-listed with this input.  
+This can be useful when you use the milestones for triage.
+
+### Example {#example}
+
+```yml {6-8}
+# ...
+name: Stale
+id: stale
+uses: sonia-corporation/stale@latest
+with:
+  pull-request-only-any-milestones: |
+    milestone-x
+    milestone-y
+```
diff --git a/src/core/inputs/inputs.enum.ts b/src/core/inputs/inputs.enum.ts
@@ -39,4 +39,5 @@ export enum EInputs {
   PULL_REQUEST_LIMIT_API_MUTATIONS_COUNT = `pull-request-limit-api-mutations-count`,
   PULL_REQUEST_LIMIT_API_QUERIES_COUNT = `pull-request-limit-api-queries-count`,
   PULL_REQUEST_ONLY_ANY_PROJECT_CARDS = `pull-request-only-any-project-cards`,
+  PULL_REQUEST_ONLY_ANY_MILESTONES = `pull-request-only-any-milestones`,
 }
diff --git a/src/core/inputs/interfaces/pull-requests-inputs.interface.ts b/src/core/inputs/interfaces/pull-requests-inputs.interface.ts
@@ -18,6 +18,7 @@ export interface IPullRequestsInputs extends IInputs {
   readonly pullRequestIgnoreDraft: boolean;
   readonly pullRequestLimitApiMutationsCount: number;
   readonly pullRequestLimitApiQueriesCount: number;
+  readonly pullRequestOnlyAnyMilestones: string[];
   readonly pullRequestOnlyAnyProjectCards: string[];
   readonly pullRequestProcessing: boolean;
   readonly pullRequestStaleComment: IComment | '';