Merge pull request #183 from mdb/additional-output

Add logging and explicit output

.github/workflows/test.yml

@@ -32,13 +32,26 @@ jobs:
         with:
           tag: 0.0.0
           token: ${{ secrets.GITHUB_TOKEN }}
+      - uses: ./
+        with:
+          tag: 0.0.0
+          token: ${{ secrets.GITHUB_TOKEN }}
   ensure-unpublished-version:
     runs-on: ubuntu-latest
     needs: test
     steps:
       - uses: actions/checkout@v3
       - name: Get package.json version
         run: echo "VERSION=$(jq -r .version package.json)" >> $GITHUB_ENV
+
+      # invoke the action with fail: false
+      - uses: ./
+        with:
+          tag: ${{ env.VERSION }}
+          token: ${{ secrets.GITHUB_TOKEN }}
+          fail: false
+
+      # invoke the action with fail: true
       - uses: ./
         with:
           tag: ${{ env.VERSION }}

README.md

@@ -4,9 +4,10 @@
 
 A GitHub Action that checks if a given GitHub release tag already exists.
 
-`ensure-unpublished-release-action` succeeds if the provided release tag
-is unique and does not already exist, and fails if the tag has already
-been published as a GitHub release.
+In default configuration, `ensure-unpublished-release-action` succeeds if the provided release tag
+is unique and does not already exist, and fails if the tag has already been published as a GitHub release.
+
+The action produces an `exists` output whose value is `true` or `false`.
 
 ## Usage
 

__tests__/main.test.ts

@@ -22,6 +22,7 @@ const repo = 'mdb/terraputs'
 const tag = '500.0.0'
 
 jest.spyOn(core, 'info').mockImplementation(jest.fn())
+jest.spyOn(core, 'setOutput').mockImplementation(jest.fn())
 jest.spyOn(core, 'setFailed').mockImplementation(jest.fn())
 
 test('release does not exist', async () => {
@@ -38,6 +39,7 @@ test('release does not exist', async () => {
   expect(core.info).toHaveBeenCalledWith(
     `${repo} release tag ${tag} does not exist`
   )
+  expect(core.setOutput).toHaveBeenCalledWith('exists', false)
 })
 
 test('release exists', async () => {
@@ -51,7 +53,6 @@ test('release exists', async () => {
   expect(core.setFailed).toHaveBeenCalledWith(
     `${repo} release tag ${tag} exists`
   )
-  expect(core.info).not.toHaveBeenCalled()
 })
 
 test('an error occurs fetching GitHub release data', async () => {

package.json

@@ -1,6 +1,6 @@
 {
   "name": "ensure-unpublished-release-action",
-  "version": "0.0.15",
+  "version": "0.1.0",
   "private": true,
   "description": "Check that a given GitHub release tag does not already exist",
   "main": "lib/main.js",

src/main.ts

@@ -8,8 +8,16 @@ export const run = async (): Promise<void> => {
   try {
     const tag: string = core.getInput('tag')
     const exists = await isExistingRelease(owner, repo, tag)
-    if (exists) core.setFailed(`${owner}/${repo} release tag ${tag} exists`)
-    if (!exists) core.info(`${owner}/${repo} release tag ${tag} does not exist`)
+
+    if (exists) {
+      core.setOutput('exists', true)
+      core.setFailed(`${owner}/${repo} release tag ${tag} exists`)
+    }
+
+    if (!exists) {
+      core.setOutput('exists', false)
+      core.info(`${owner}/${repo} release tag ${tag} does not exist`)
+    }
   } catch (error) {
     if (error instanceof Error) core.setFailed(error.message)
   }