Merge pull request #111 from dblock/search-existing

Added search_existing param.

Author: JasonEtco

README.md

@@ -87,9 +87,12 @@ steps:
       assignees: JasonEtco, octocat
       milestone: 1
       update_existing: true
+      search_existing: all
 ```
 
-The `assignees` and `milestone` speak for themselves, the `update_existing` param can be passed and set to `true` when you want to update an open issue with the **exact same title** when it exists and `false` if you don't want to create a new issue, but skip updating an existing one.
+* The `assignees` and `milestone` speak for themselves.
+* The `update_existing` param can be passed and set to `true` when you want to update an open issue with the **exact same title** when it exists and `false` if you don't want to create a new issue, but skip updating an existing one.
+* The `search_existing` param lets you specify whether to search `open`, `closed`, or `all` existing issues for duplicates (default is `open`).
 
 ### Outputs
 

action.yml

@@ -20,6 +20,10 @@ inputs:
   update_existing:
     description: Update an open existing issue with the same title if it exists
     required: false
+  search_existing:
+    description: Existing types of issues to search for (comma-separated)
+    required: false
+    default: open
 outputs:
   number:
     description: Number of the issue that was created

package-lock.json

@@ -9,6 +9,8 @@ import { FrontMatterAttributes, listToArray, setOutputs } from './helpers'
 export async function createAnIssue (tools: Toolkit) {
   const template = tools.inputs.filename || '.github/ISSUE_TEMPLATE.md'
   const assignees = tools.inputs.assignees
+  const searchExistingType = tools.inputs.search_existing || 'open'
+
   let updateExisting: Boolean | null = null
   if (tools.inputs.update_existing) {
     if (tools.inputs.update_existing === 'true') {
@@ -19,6 +21,7 @@ export async function createAnIssue (tools: Toolkit) {
       tools.exit.failure(`Invalid value update_existing=${tools.inputs.update_existing}, must be one of true or false`)
     }
   }
+
   const env = nunjucks.configure({ autoescape: false })
   env.addFilter('date', dateFilter)
 
@@ -48,7 +51,7 @@ export async function createAnIssue (tools: Toolkit) {
     tools.log.info(`Fetching issues with title "${templated.title}"`)
     try {
       const existingIssues = await tools.github.search.issuesAndPullRequests({
-        q: `is:open is:issue repo:${process.env.GITHUB_REPOSITORY} in:title ${templated.title}`
+        q: `is:${searchExistingType} is:issue repo:${process.env.GITHUB_REPOSITORY} in:title ${templated.title}`
       })
       existingIssue = existingIssues.data.items.find(issue => issue.title === templated.title)
     } catch (err) {
@@ -66,7 +69,7 @@ export async function createAnIssue (tools: Toolkit) {
             body: templated.body
           })
           setOutputs(tools, issue)
-          tools.exit.success(`Updated issue ${existingIssue.title}#${issue.data.number}: ${issue.data.html_url}`)
+          tools.exit.success(`Updated issue ${existingIssue.title}#${existingIssue.number}: ${existingIssue.html_url}`)
         } catch (err) {
           tools.exit.failure(err)
         }

src/action.ts

@@ -239,7 +239,7 @@ Array [
 ]
 `;
 
-exports[`create-an-issue updates an existing issue with the same title 1`] = `
+exports[`create-an-issue updates an existing open issue with the same title 1`] = `
 Object {
   "assignees": Array [
     "octocat",

tests/__snapshots__/index.test.ts.snap

@@ -151,6 +151,32 @@ describe('create-an-issue', () => {
     expect(tools.log.success).toHaveBeenCalled()
   })
 
+  it('updates an existing open issue with the same title', async () => {
+    nock.cleanAll()
+    nock('https://api.github.com')
+      .get(/\/search\/issues.*/)
+      .query(parsedQuery => {
+        const q = parsedQuery['q']
+        if (typeof(q) === 'string') {
+          const args = q.split(' ')
+          return (args.includes('is:open') || args.includes('is:closed')) 
+            && args.includes('is:issue')
+        } else {
+          return false
+        }
+      })
+      .reply(200, {
+        items: [{ number: 1, title: 'Hello!' }]
+      })
+      .patch(/\/repos\/.*\/.*\/issues\/.*/).reply(200, {})
+
+    process.env.INPUT_UPDATE_EXISTING = 'true'
+
+    await createAnIssue(tools)
+    expect(params).toMatchSnapshot()
+    expect(tools.exit.success).toHaveBeenCalled()
+  })
+  
   it('checks the value of update_existing', async () => {
     process.env.INPUT_UPDATE_EXISTING = 'invalid'
 
@@ -159,23 +185,28 @@ describe('create-an-issue', () => {
     expect(tools.exit.failure).toHaveBeenCalledWith('Invalid value update_existing=invalid, must be one of true or false')
   })
 
-  it('updates an existing issue with the same title', async () => {
+  it('updates an existing closed issue with the same title', async () => {
     nock.cleanAll()
     nock('https://api.github.com')
-      .get(/\/search\/issues.*/).reply(200, {
-        items: [{ number: 1, title: 'Hello!', html_url: '/issues/1' }]
-      })
-      .patch(/\/repos\/.*\/.*\/issues/).reply(200, (_, body: any) => {
-        return {
-          title: body.title,
-          number: 1,
-          html_url: '/issues/1'
+      .get(/\/search\/issues.*/)
+      .query(parsedQuery => {
+        const q = parsedQuery['q']
+        if (typeof(q) === 'string') {
+          const args = q.split(' ')
+          return args.includes('is:all') && args.includes('is:issue')
+        } else {
+          return false
         }
       })
+      .reply(200, {
+        items: [{ number: 1, title: 'Hello!', html_url: '/issues/1' }]
+      })
+      .patch(/\/repos\/.*\/.*\/issues\/.*/).reply(200, {})
+
     process.env.INPUT_UPDATE_EXISTING = 'true'
+    process.env.INPUT_SEARCH_EXISTING = 'all'
 
     await createAnIssue(tools)
-    expect(params).toMatchSnapshot()
     expect(tools.exit.success).toHaveBeenCalledWith('Updated issue Hello!#1: /issues/1')
   })