Merge pull request #894 from Sonia-corporation/feature/merge-develop-…

…into-master
Sonia-corporation · Aug 31, 2022 · 67c62b9 · 67c62b9 · vercel · Aug 31, 2022
2 parents c862ad1 + 9c52b45
commit 67c62b9
Show file tree

Hide file tree

Showing 27 changed files with 255 additions and 647 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -207,7 +207,7 @@ To help us have a clear vision over the workflow and also for you if you are jus
   - 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
     - Else, check if pull request last update is older than X days (coming from `pull-request-days-before-close`)
-      - If it is old, close the pull request (using the close reason coming from `pull-request-close-reason`)
+      - If it is old, close the pull request
       - Check if the action should also add a comment (coming from the `pull-request-close-comment` input)
         - 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)

diff --git a/README.md b/README.md
diff --git a/action.yml b/action.yml
@@ -233,10 +233,6 @@ inputs:
     description: 'Allow to process the pull requests.'
     required: false
     default: 'true'
-  pull-request-close-reason:
-    description: 'The reason when closing a pull request (completed or not planned).'
-    required: false
-    default: 'not planned'
   pull-request-add-labels-after-stale:
     description: 'A list of labels added when the processing stale the pull request (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
@@ -77,7 +77,6 @@ The list of all the inputs.
 | [issue-remove-labels-after-stale](issues/inputs/issue-remove-labels-after-stale-input)                          | A list of labels removed when the processing stale the issue (multiline).                                                                              |                       |
 | [issue-add-labels-after-close](issues/inputs/issue-add-labels-after-close-input)                                | A list of labels added when the processing close the issue (multiline).                                                                                |                       |
 | [pull-request-processing](pull-requests/inputs/pull-request-processing-input)                                   | Allow to process the pull requests.                                                                                                                    | `true`                |
-| [pull-request-close-reason](pull-requests/inputs/pull-request-close-reason-input)                               | The reason when closing a pull request (`completed` or `not planned`).                                                                                 | `not planned`         |
 | [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).                                                                         |                       |

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
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,8 +24,7 @@ This can be useful if you wish to improve the communication and the process on h
 
 :::note
 
-You can also specify the reason for closing this pull request by using the [close reason input](pull-request-close-reason-input),
-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)
 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,8 +29,7 @@ The pull request will be closed tomorrow if no update occur until then.
 
 :::info
 
-You can also specify the reason for closing this pull request by using the [close reason input](pull-request-close-reason-input),
-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)
 and add a comment to explain why it was closed by using the [close comment input](pull-request-close-comment-input).
 
 :::

diff --git a/...nputs/72-add-labels-after-stale-input.mdx → ...nputs/71-add-labels-after-stale-input.mdx b/...nputs/72-add-labels-after-stale-input.mdx → ...nputs/71-add-labels-after-stale-input.mdx
diff --git a/documentation/docs/08-pull-requests/01-inputs/71-close-reason-input.mdx b/documentation/docs/08-pull-requests/01-inputs/71-close-reason-input.mdx
diff --git a/...ts/73-remove-labels-after-stale-input.mdx → ...ts/72-remove-labels-after-stale-input.mdx b/...ts/73-remove-labels-after-stale-input.mdx → ...ts/72-remove-labels-after-stale-input.mdx
diff --git a/...nputs/74-add-labels-after-close-input.mdx → ...nputs/73-add-labels-after-close-input.mdx b/...nputs/74-add-labels-after-close-input.mdx → ...nputs/73-add-labels-after-close-input.mdx
@@ -31,8 +31,7 @@ If not, the GitHub API will throw an error.
 
 :::info
 
-You can also specify the reason for closing this pull request by using the [close reason input](pull-request-close-reason-input),
-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)
 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/...ts/75-to-draft-instead-of-stale-input.mdx → ...ts/74-to-draft-instead-of-stale-input.mdx b/...ts/75-to-draft-instead-of-stale-input.mdx → ...ts/74-to-draft-instead-of-stale-input.mdx
diff --git a/...ts/76-delete-branch-after-close-input.mdx → ...ts/75-delete-branch-after-close-input.mdx b/...ts/76-delete-branch-after-close-input.mdx → ...ts/75-delete-branch-after-close-input.mdx
diff --git a/documentation/docs/16-migrations/02-migration-to-2.md b/documentation/docs/16-migrations/02-migration-to-2.md
@@ -16,21 +16,20 @@ From [v1](https://github.com/Sonia-corporation/stale/releases/tag/1.61.0) to [v2
 
 ### Close reason 🍬 {#close-reason}
 
-These two new inputs were introduced:
+One new input was introduced:
 
 - [issue-close-reason](../issues/inputs/issue-close-reason-input)
-- [pull-request-close-reason](../pull-requests/inputs/pull-request-close-reason-input)
 
-They will allow you to define what is the reason when an issue or a pull request is closed.  
+It will allow you to define what is the reason when an issue is closed.  
 This new feature is possible following the [May 19, 2022, update](https://github.blog/changelog/2022-05-19-the-new-github-issues-may-19th-update/#%F0%9F%95%B5%F0%9F%8F%BD%E2%99%80%EF%B8%8F-issue-closed-reasons) for the GitHub issues.
 
 **Before:**
 
-Every issue and pull request were closed with the default value in GitHub, which is `COMPLETED`.
+Every issue were closed with the default value in GitHub, which is `COMPLETED`.
 
 **After:**
 
-Every issue and pull request will now be closed with `NOT_PLANNED` as the default value.  
+Every issue will now be closed with `NOT_PLANNED` as the default value.  
 To change the behavior back to the previous one, you can configure your action as follows:
 
 ```yml {6-7}
@@ -40,12 +39,11 @@ id: stale
 uses: sonia-corporation/stale@latest
 with:
   issue-close-reason: 'not planned'
-  pull-request-close-reason: 'not planned'
 ```
 
 :::info
 
-We decided to actually change the default value, because it makes more sense for most users to consider a close issue or pull request as not planned.  
+We decided to actually change the default value, because it makes more sense for most users to consider a closed issue as not planned.  
 Like suggested by GitHub, they consider this value as a stale reason, which is actually why you are here. 😉
 
 :::
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -134,7 +134,7 @@
     "cross-env": "7.0.3",
     "cz-customizable": "6.9.2",
     "cz-customizable-ghooks": "2.0.0",
-    "eslint": "8.23.0",
+    "eslint": "8.22.0",
     "eslint-config-google": "0.14.0",
     "eslint-config-prettier": "8.5.0",
     "eslint-config-recommended": "4.1.0",

diff --git a/src/core/inputs/inputs.enum.ts b/src/core/inputs/inputs.enum.ts
@@ -32,7 +32,6 @@ export enum EInputs {
   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_CLOSE_COMMENT = `pull-request-close-comment`,
-  PULL_REQUEST_CLOSE_REASON = `pull-request-close-reason`,
   PULL_REQUEST_DAYS_BEFORE_CLOSE = `pull-request-days-before-close`,
   PULL_REQUEST_DAYS_BEFORE_STALE = `pull-request-days-before-stale`,
   PULL_REQUEST_DELETE_BRANCH_AFTER_CLOSE = `pull-request-delete-branch-after-close`,

diff --git a/src/core/inputs/interfaces/pull-requests-inputs.interface.ts b/src/core/inputs/interfaces/pull-requests-inputs.interface.ts
@@ -1,4 +1,3 @@
-import { ECloseReason } from '@core/inputs/enums/close-reason.enum';
 import { IInputs } from '@core/inputs/types/inputs';
 import { IIso8601Date } from '@utils/dates/iso-8601';
 import { IComment } from '@utils/types/comment';
@@ -7,7 +6,6 @@ export interface IPullRequestsInputs extends IInputs {
   readonly pullRequestAddLabelsAfterClose: string[];
   readonly pullRequestAddLabelsAfterStale: string[];
   readonly pullRequestCloseComment: IComment | '';
-  readonly pullRequestCloseReason: ECloseReason;
   readonly pullRequestDaysBeforeClose: number;
   readonly pullRequestDaysBeforeStale: number;
   readonly pullRequestDeleteBranchAfterClose: boolean;