feat(issues): add new input issue-only-with-milestones

This new input allows to only process issues containing at least one milestone. Closes #808
Sonia-corporation · Aug 22, 2022 · 8083fa8 · 8083fa8
1 parent c3727be
commit 8083fa8
Show file tree

Hide file tree

Showing 19 changed files with 557 additions and 91 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -146,6 +146,7 @@ To help us have a clear vision over the workflow and also for you if you are jus
 - Check if the input `issue-only-any-assignees` contains some assignees. If this is the case and the issue has at least one assignee matching linked to it, the processing will continue, else the processing will stop.
 - Check if the input `issue-only-with-assignees` contains some assignees. If this is the case and the issue has at least one assignee linked to it, the processing will continue, else the processing will stop.
 - Check if the input `issue-only-with-project-cards` contains some project cards. If this is the case and the issue has at least one project card linked to it, the processing will continue, else the processing will stop.
+- Check if the input `issue-only-with-milestones` contains some milestones. If this is the case and the issue has at least one milestone linked to it, the processing will continue, else the processing will stop.
 - Check if the issue has already a stale state (stale label)
   - If the issue 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
@@ -96,6 +96,7 @@ All the inputs that are used both for issues and pull requests.
 | **Milestones**                                                                                                                            |                                                                                                                                                 |         |
 | [issue-ignore-all-milestones](https://sonia-corporation.github.io/stale/docs/issues/inputs/issue-ignore-all-milestones-input)             | Allow to ignore the processing of issues that contains any milestones.                                                                          | `false` |
 | [issue-ignore-any-milestones](https://sonia-corporation.github.io/stale/docs/issues/inputs/issue-ignore-any-milestones-input)             | Allow to ignore the processing of issues that contains one of those milestones (multiline).                                                     |         |
+| [issue-only-with-milestones](https://sonia-corporation.github.io/stale/docs/issues/inputs/issue-only-wih-milestones-input)                | Only allow the processing of issues that contains at least one milestone.                                                                       | `false` |
 | [issue-only-any-milestones](https://sonia-corporation.github.io/stale/docs/issues/inputs/issue-only-any-milestones-input)                 | Only allow the processing of issues that contains one of those milestones (multiline).                                                          |         |
 | **Comments**                                                                                                                              |                                                                                                                                                 |         |
 | [issue-stale-comment](https://sonia-corporation.github.io/stale/docs/issues/inputs/issue-stale-comment-input)                             | The comment that will be sent once the issue is stale (keep empty to not send a comment).                                                       |         |

diff --git a/action.yml b/action.yml
@@ -68,6 +68,10 @@ inputs:
     description: 'Allow to ignore the processing of issues that contains one of those milestones (multiline).'
     required: false
     default: ''
+  issue-only-with-milestones:
+    description: 'Only allow the processing of issues that contains at least one milestone.'
+    required: false
+    default: 'false'
   issue-only-any-milestones:
     description: 'Only allow the processing of issues that contains one of those milestones (multiline).'
     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
@@ -46,6 +46,7 @@ The list of all the inputs.
 | **Milestones**                                                                                                  |                                                                                                                                                        |                       |
 | [issue-ignore-all-milestones](issues/inputs/issue-ignore-all-milestones-input)                                  | Allow to ignore the processing of issues that contains any milestones.                                                                                 | `false`               |
 | [issue-ignore-any-milestones](issues/inputs/issue-ignore-any-milestones-input)                                  | Allow to ignore the processing of issues that contains one of those milestones (multiline).                                                            |                       |
+| [issue-only-with-milestones](issues/inputs/issue-only-with-milestones-input)                                    | Only allow the processing of issues that contains at least one milestone.                                                                              | `false`               |
 | [issue-only-any-milestones](issues/inputs/issue-only-any-milestones-input)                                      | Only allow the processing of issues that contains one of those milestones (multiline).                                                                 |                       |
 | [pull-request-ignore-all-milestones](pull-requests/inputs/pull-request-ignore-all-milestones-input)             | Allow to ignore the processing of pull requests that contains any milestones.                                                                          | `false`               |
 | [pull-request-ignore-any-milestones](pull-requests/inputs/pull-request-ignore-any-milestones-input)             | Allow to ignore the processing of pull requests that contains one of those milestones (multiline).                                                     |                       |

diff --git a/documentation/docs/06-issues/01-inputs/01-all-inputs.mdx b/documentation/docs/06-issues/01-inputs/01-all-inputs.mdx
@@ -29,6 +29,7 @@ The list of all issues the inputs.
 | **Milestones**                                                               |                                                                                                                                                 |         |
 | [issue-ignore-all-milestones](issue-ignore-all-milestones-input)             | Allow to ignore the processing of issues that contains any milestones.                                                                          | `false` |
 | [issue-ignore-any-milestones](issue-ignore-any-milestones-input)             | Allow to ignore the processing of issues that contains one of those milestones (multiline).                                                     |         |
+| [issue-only-with-milestones](issue-only-with-milestones-input)               | Only allow the processing of issues that contains at least one milestone.                                                                       | `false` |
 | [issue-only-any-milestones](issue-only-any-milestones-input)                 | Only allow the processing of issues that contains one of those milestones (multiline).                                                          |         |
 | **Comments**                                                                 |                                                                                                                                                 |         |
 | [issue-stale-comment](issue-stale-comment-input)                             | The comment that will be sent once the issue is stale (keep empty to not send a comment).                                                       |         |

diff --git a/documentation/docs/06-issues/01-inputs/32-only-with-milestones-input.mdx b/documentation/docs/06-issues/01-inputs/32-only-with-milestones-input.mdx
@@ -0,0 +1,33 @@
+---
+id: issue-only-with-milestones-input
+title: Issue only with milestones input
+description: |
+  All the information you need to know about the issue only with milestones input.
+  Including a detailed description and an example.
+tags:
+  - Issues
+  - Inputs
+  - Milestones
+---
+
+### Input {#input}
+
+Name: `issue-only-with-milestones`  
+Type: `boolean`  
+Default value: `false`
+
+### Description {#description}
+
+This input will let you process only the issues that are linked to at least one milestone.  
+This can be useful when you use the milestones for triage.
+
+### Example {#example}
+
+```yml {6}
+# ...
+name: Stale
+id: stale
+uses: sonia-corporation/stale@latest
+with:
+  issue-only-with-milestones: true
+```
diff --git a/...1-inputs/32-only-any-milestones-input.mdx → ...1-inputs/33-only-any-milestones-input.mdx b/...1-inputs/32-only-any-milestones-input.mdx → ...1-inputs/33-only-any-milestones-input.mdx
diff --git a/src/core/inputs/inputs.enum.ts b/src/core/inputs/inputs.enum.ts
@@ -19,6 +19,7 @@ export enum EInputs {
   ISSUE_LIMIT_API_QUERIES_COUNT = `issue-limit-api-queries-count`,
   ISSUE_ONLY_ANY_ASSIGNEES = `issue-only-any-assignees`,
   ISSUE_ONLY_WITH_ASSIGNEES = `issue-only-with-assignees`,
+  ISSUE_ONLY_WITH_MILESTONES = `issue-only-with-milestones`,
   ISSUE_ONLY_WITH_PROJECT_CARDS = `issue-only-with-project-cards`,
   ISSUE_ONLY_ANY_MILESTONES = `issue-only-any-milestones`,
   ISSUE_ONLY_ANY_PROJECT_CARDS = `issue-only-any-project-cards`,

diff --git a/src/core/inputs/interfaces/issues-inputs.interface.ts b/src/core/inputs/interfaces/issues-inputs.interface.ts
@@ -23,6 +23,7 @@ export interface IIssuesInputs extends IInputs {
   readonly issueOnlyAnyMilestones: string[];
   readonly issueOnlyAnyProjectCards: string[];
   readonly issueOnlyWithAssignees: boolean;
+  readonly issueOnlyWithMilestones: boolean;
   readonly issueOnlyWithProjectCards: boolean;
   readonly issueProcessing: boolean;
   readonly issueStaleComment: IComment | '';