feat: add option to overwrite existing milestone

Author: benelan

.github/workflows/add-milestone-close.yml

@@ -10,4 +10,6 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
-      - uses: ./
+      - uses: ./
+        with:
+          overwrite: true # remove this line to keep existing milestone

README.md

@@ -16,7 +16,7 @@ on:
     types: [opened]
     branches: [master]
   pull_request:
-    types: [opened]
+    types: [closed]
     branches: [master]
 jobs:
   add:
@@ -25,6 +25,7 @@ jobs:
       - uses: benelan/[email protected]
         with:
           farthest: true # remove this line to add the current milestone
+          overwrite: true # remove this line to keep an existing milestone
 ```
 
 

action.yml

@@ -10,9 +10,13 @@ inputs:
     default: ${{ github.token }}
     required: false
   farthest:
-    description: 'Set this boolean to `true` if you want to add the milestone with the farthest due date. Defaults to `false` which adds the current milestone.'
+    description: 'Set this boolean to `true` if you want to add the milestone with the farthest due date. Defaults to `false`, which adds the current milestone.'
     required: false
-    default: false
+    default: 'false'
+  overwrite:
+    description: 'Set this boolean to `true` if you want the action to overwrite existing milestones on issues. Defaults to `false`, which ends the run if the issue already has a milestone.'
+    required: false
+    default: 'false'
 runs:
   using: 'node12'
   main: 'dist/index.js'

dist/index.js

@@ -10,42 +10,37 @@ async function run(): Promise<void> {
     } = context
 
     // https://github.blog/changelog/2021-02-19-github-actions-workflows-triggered-by-dependabot-prs-will-run-with-read-only-permissions/
-    if (sender && sender.login === 'dependabot[bot]') {
+    if (sender?.login === 'dependabot[bot]') {
       console.log('Dependabot created the pull request, ending run.')
       return
     }
 
-    if (!issue && !pull_request) {
-      console.log(
-        'The event that triggered this action was not a pull request or issue, ending run.'
-      )
-      return
-    }
+    const farthest = getBooleanInput('farthest')
+    const overwrite = getBooleanInput('overwrite')
+    const token = getInput('repo-token')
+    const octokit = getOctokit(token)
 
-    if (!!issue?.milestone || !!pull_request?.milestone) {
+    if (!overwrite && (issue?.milestone || pull_request?.milestone)) {
       console.log(
-        'The issue or pull request already has a milestone, ending run.'
+        'The `overwrite` option is not enabled and the issue or pull request already has a milestone, ending run.'
       )
       return
     }
 
-    const farthest = getBooleanInput('farthest')
-    const token = getInput('repo-token')
-    const octokit = getOctokit(token)
-
     const {data: milestones} = await octokit.rest.issues.listMilestones({
       ...repo,
       state: 'open',
       sort: 'due_on',
+      per_page: 100,
       direction: farthest ? 'desc' : 'asc'
     })
 
-    if (milestones.length === 0) {
+    if (!milestones.length) {
       console.log('There are no open milestones in this repo, ending run.')
       return
     }
 
-    const currentDate = new Date()
+    const currentDate = new Date(Date.now())
     for (const milestone of milestones) {
       if (milestone.due_on && new Date(milestone.due_on) > currentDate) {
         await octokit.rest.issues.update({
@@ -57,6 +52,7 @@ async function run(): Promise<void> {
         return
       }
     }
+    console.log('No matching milestone was found or added, ending run.')
   } catch (e) {
     if (e instanceof Error) {
       setFailed(e.message)