Merge pull request #498 from /issues/497

Fix #497: Support for release output

.github/workflows/default.yml

@@ -15,10 +15,21 @@ jobs:
       - run: npm install
       - run: npm run all
 
+      - uses: ./
+        id: test-0
+        with:
+          version: wrong
+      - run: '[[ "" == "${{ steps.test-1.outputs.release }}" ]]'
+      - run: '[[ "" == "${{ steps.test-1.outputs.major }}" ]]'
+      - run: '[[ "" == "${{ steps.test-1.outputs.minor }}" ]]'
+      - run: '[[ "" == "${{ steps.test-1.outputs.patch }}" ]]'
+      - run: '[[ "" == "${{ steps.test-1.outputs.any_other_property }}" ]]'
+
       - uses: ./
         id: test-1
         with:
           version: 1.2.3-alpha.gamma+4.5.6
+      - run: '[[ "1.2.3" == "${{ steps.test-1.outputs.release }}" ]]'
       - run: '[[ "1" == "${{ steps.test-1.outputs.major }}" ]]'
       - run: '[[ "2" == "${{ steps.test-1.outputs.minor }}" ]]'
       - run: '[[ "3" == "${{ steps.test-1.outputs.patch }}" ]]'

README.md

@@ -24,6 +24,7 @@ A wrapper around [semver](https://www.npmjs.com/package/semver), so read [its do
     # A range to check against
     satisfies: 1.x
 - run: |
+    echo "${{ steps.version.outputs.release }}"           # 1.2.3
     echo "${{ steps.version.outputs.major }}"             # 1
     echo "${{ steps.version.outputs.minor }}"             # 2
     echo "${{ steps.version.outputs.patch }}"             # 3
@@ -42,6 +43,8 @@ A wrapper around [semver](https://www.npmjs.com/package/semver), so read [its do
     echo "${{ steps.version.outputs.inc-prerelease }}"    # 1.2.4-0
 ```
 
+If the version cannot be parsed, all the outputs [will be equal to an empty string](.github/workflows/default.yml#L18-L26).
+
 If any of the inputs cannot be parsed, it is just silently ignored.
 This action tries its best not to fail.
 

__tests__/main.test.ts

@@ -110,6 +110,7 @@ describe('parse', () => {
           const parsedVersion = parse(item.version)
 
           if (parsedVersion) {
+            expect(stdout).toContain(`::set-output name=release::${parsedVersion.major}.${parsedVersion.minor}.${parsedVersion.patch}`)
             expect(stdout).toContain(`::set-output name=major::${parsedVersion.major}`)
             expect(stdout).toContain(`::set-output name=minor::${parsedVersion.minor}`)
             expect(stdout).toContain(`::set-output name=patch::${parsedVersion.patch}`)
@@ -128,6 +129,7 @@ describe('parse', () => {
               })
             }
           } else {
+            expect(stdout).not.toContain(`::set-output name=release::`)
             expect(stdout).not.toContain(`::set-output name=major::`)
             expect(stdout).not.toContain(`::set-output name=minor::`)
             expect(stdout).not.toContain(`::set-output name=patch::`)

action-types.yml

@@ -8,6 +8,8 @@ inputs:
   identifier:
     type: string
 outputs:
+  release:
+    type: string
   major:
     type: string
   minor:

action.yml

@@ -15,6 +15,8 @@ inputs:
     required: false
     description: An identifier to pass to the semver's inc function
 outputs:
+  release:
+    description: Version's release (major.minor.patch)
   major:
     description: Version's major number
   minor:

package.json

@@ -1,6 +1,6 @@
 {
   "name": "semver-utils",
-  "version": "2.2.0",
+  "version": "2.3.0",
   "private": true,
   "description": "One-stop shop for working with semantic versions in your workflows",
   "main": "lib/main.js",

src/main.ts

@@ -10,6 +10,7 @@ async function run(): Promise<void> {
       return
     }
 
+    core.setOutput('release', `${version.major}.${version.minor}.${version.patch}`)
     core.setOutput('major', version.major)
     core.setOutput('minor', version.minor)
     core.setOutput('patch', version.patch)