Merge branch 'main' into search-existing

Author: JasonEtco

README.md

@@ -91,7 +91,7 @@ steps:
 ```
 
 * 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.
+* 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

src/action.ts

@@ -9,8 +9,19 @@ 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 updateExisting = Boolean(tools.inputs.update_existing)
   const searchExistingType = tools.inputs.search_existing || 'open'
+
+  let updateExisting: Boolean | null = null
+  if (tools.inputs.update_existing) {
+    if (tools.inputs.update_existing === 'true') {
+      updateExisting = true
+    } else if (tools.inputs.update_existing === 'false') {
+      updateExisting = false
+    } else {
+      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)
 
@@ -35,7 +46,7 @@ export async function createAnIssue (tools: Toolkit) {
   }
   tools.log.debug('Templates compiled', templated)
 
-  if (updateExisting) {
+  if (updateExisting !== null) {
     let existingIssue
     tools.log.info(`Fetching issues with title "${templated.title}"`)
     try {
@@ -47,19 +58,25 @@ export async function createAnIssue (tools: Toolkit) {
       tools.exit.failure(err)
     }
     if (existingIssue) {
-      try {
-        const issue = await tools.github.issues.update({
-          ...tools.context.repo,
-          issue_number: existingIssue.number,
-          body: templated.body
-        })
-        setOutputs(tools, issue)
-        tools.exit.success(`Updated issue ${issue.data.title}#${issue.data.number}: ${issue.data.html_url}`)
-      } catch (err) {
-        tools.exit.failure(err)
+      if (updateExisting === false) {
+        tools.exit.success(`Existing issue ${existingIssue.title}#${existingIssue.number}: ${existingIssue.html_url} found but not updated`)
+      } else {
+        try {
+          tools.log.info(`Updating existing issue ${existingIssue.title}#${existingIssue.number}: ${existingIssue.html_url}`)
+          const issue = await tools.github.issues.update({
+            ...tools.context.repo,
+            issue_number: existingIssue.number,
+            body: templated.body
+          })
+          setOutputs(tools, issue)
+          tools.exit.success(`Updated issue ${existingIssue.title}#${issue.data.number}: ${issue.data.html_url}`)
+        } catch (err) {
+          tools.exit.failure(err)
+        }
       }
+    } else {
+      tools.log.info('No existing issue found to update')
     }
-    tools.log.info('No existing issue found to update')
   }
 
   // Create the new issue

tests/__snapshots__/index.test.ts.snap

@@ -1,5 +1,18 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
+exports[`create-an-issue checks the value of update_existing 1`] = `
+Object {
+  "assignees": Array [
+    "octocat",
+    "JasonEtco",
+  ],
+  "body": "Goodbye!",
+  "labels": Array [],
+  "milestone": 1,
+  "title": "Hello!",
+}
+`;
+
 exports[`create-an-issue creates a new issue 1`] = `
 Object {
   "assignees": Array [],
@@ -184,6 +197,19 @@ Array [
 ]
 `;
 
+exports[`create-an-issue finds, but does not update an existing issue with the same title 1`] = `
+Object {
+  "assignees": Array [
+    "octocat",
+    "JasonEtco",
+  ],
+  "body": "Goodbye!",
+  "labels": Array [],
+  "milestone": 1,
+  "title": "Hello!",
+}
+`;
+
 exports[`create-an-issue logs a helpful error if creating an issue throws an error 1`] = `
 Array [
   Array [

tests/index.test.ts

@@ -176,6 +176,14 @@ describe('create-an-issue', () => {
     expect(params).toMatchSnapshot()
     expect(tools.exit.success).toHaveBeenCalled()
   })
+  
+  it('checks the value of update_existing', async () => {
+    process.env.INPUT_UPDATE_EXISTING = 'invalid'
+
+    await createAnIssue(tools)
+    expect(params).toMatchSnapshot()
+    expect(tools.exit.failure).toHaveBeenCalledWith('Invalid value update_existing=invalid, must be one of true or false')
+  })
 
   it('updates an existing closed issue with the same title', async () => {
     nock.cleanAll()
@@ -201,14 +209,27 @@ describe('create-an-issue', () => {
 
     await createAnIssue(tools)
     expect(params).toMatchSnapshot()
-    expect(tools.exit.success).toHaveBeenCalled()
+    expect(tools.exit.success).toHaveBeenCalledWith('Updated issue Hello!#1: /issues/1')
+  })
+
+  it('finds, but does not update an existing 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' }]
+      })
+    process.env.INPUT_UPDATE_EXISTING = 'false'
+
+    await createAnIssue(tools)
+    expect(params).toMatchSnapshot()
+    expect(tools.exit.success).toHaveBeenCalledWith('Existing issue Hello!#1: /issues/1 found but not updated')
   })
 
   it('exits when updating an issue fails', async () => {
     nock.cleanAll()
     nock('https://api.github.com')
       .get(/\/search\/issues.*/).reply(200, {
-        items: [{ number: 1, title: 'Hello!' }]
+        items: [{ number: 1, title: 'Hello!', html_url: '/issues/1' }]
       })
       .patch(/\/repos\/.*\/.*\/issues\/.*/).reply(500, {
         message: 'Updating issue failed'