Merge pull request #32 from issue-ops/version-check

Version check

README.md

@@ -88,6 +88,8 @@ jobs:
 | `manifest-path` | The path to the manifest file that contains the version.   |
 |                 | Relative to the root of the repository.                    |
 |                 | If not set, `use-version` must be set.                     |
+| `overwrite`     | Set to `'true'` for the action to overwrite existing tags. |
+|                 | Default: `'false'`                                         |
 | `ref`           | The Git ref to tag with the specified or inferred version. |
 |                 | Defaults to the base ref of a pull request event trigger.  |
 | `use-version`   | The version you want to explicitly use.                    |
@@ -111,6 +113,13 @@ The action outputs the following (assuming the version in the manifest file is
 | `patch`             | The patch version                    | `3`             |
 | `prerelease`        | The prerelease version               | `alpha.4`       |
 
+## Errors
+
+If the `overwrite` parameter is `'false'` (the default value), this action will
+fail if there is an existing version tag in the repository that matches the
+inferred or provided version. This is to prevent releases from overwriting one
+another.
+
 ## Example
 
 Assume a Node.js repository has the following tag and commit structure:

__tests__/main.test.ts

@@ -13,6 +13,7 @@ jest.mock('@actions/core', () => {
     debug: jest.fn(),
     getInput: jest.fn(),
     info: jest.fn(),
+    error: jest.fn(),
     setFailed: jest.fn(),
     setOutput: jest.fn()
   }
@@ -71,6 +72,8 @@ describe('main', () => {
           return '.'
         case 'manifest-path':
           return '/fixtures/valid/node/package.json'
+        case 'overwrite':
+          return 'true'
         default:
           return ''
       }
@@ -83,7 +86,8 @@ describe('main', () => {
       patch: '3',
       prerelease: 'alpha.4',
       toString: jest.fn().mockReturnValue('1.2.3-alpha.4'),
-      tag: jest.fn()
+      tag: jest.fn(),
+      exists: jest.fn().mockImplementation(() => false)
     } as Version
 
     jest.spyOn(Version, 'infer').mockReturnValue(mockVersion)
@@ -104,6 +108,8 @@ describe('main', () => {
           return '.'
         case 'manifest-path':
           return '/fixtures/valid/node/package.json'
+        case 'overwrite':
+          return 'true'
         default:
           return ''
       }
@@ -129,6 +135,8 @@ describe('main', () => {
           return '.'
         case 'manifest-path':
           return '/fixtures/valid/node/package.json'
+        case 'overwrite':
+          return 'true'
         default:
           return ''
       }
@@ -141,7 +149,8 @@ describe('main', () => {
       patch: '3',
       prerelease: 'alpha.4',
       toString: jest.fn().mockReturnValue('1.2.3-alpha.4'),
-      tag: jest.fn()
+      tag: jest.fn(),
+      exists: jest.fn().mockImplementation(() => false)
     } as Version
 
     jest.spyOn(Version, 'infer').mockReturnValue(mockVersion)
@@ -170,6 +179,8 @@ describe('main', () => {
           return 'refs/heads/main'
         case 'use-version':
           return '1.2.3-alpha.4'
+        case 'overwrite':
+          return 'true'
         default:
           return ''
       }
@@ -187,4 +198,41 @@ describe('main', () => {
     expect(setOutputMock).toHaveBeenCalledWith('prerelease', 'alpha.4')
     expect(runMock).toHaveReturned()
   })
+
+  it('fails if the version exists', async () => {
+    // Return valid values for all inputs
+    jest.spyOn(core, 'getInput').mockImplementation((name: string): string => {
+      switch (name) {
+        case 'ref':
+          return 'refs/heads/main'
+        case 'workspace':
+          return '.'
+        case 'manifest-path':
+          return '/fixtures/valid/node/package.json'
+        case 'overwrite':
+          return 'false'
+        default:
+          return ''
+      }
+    })
+
+    // Mock the return value from Version.infer()
+    const mockVersion = {
+      major: '1',
+      minor: '2',
+      patch: '3',
+      prerelease: 'alpha.4',
+      toString: jest.fn().mockReturnValue('1.2.3-alpha.4'),
+      tag: jest.fn(),
+      exists: jest.fn().mockImplementation(() => true)
+    } as Version
+
+    jest.spyOn(Version, 'infer').mockReturnValue(mockVersion)
+
+    await main.run()
+
+    expect(runMock).toHaveBeenCalled()
+    expect(setFailedMock).toHaveBeenCalled()
+    expect(runMock).toHaveReturned()
+  })
 })

__tests__/version.test.ts

@@ -24,6 +24,11 @@ describe('version', () => {
     jest.clearAllMocks()
   })
 
+  it('removes a leading "v"', async () => {
+    expect(new Version('v1.2.3-alpha.4').major).toEqual('1')
+    expect(new Version('V1.2.3-alpha.4').major).toEqual('1')
+  })
+
   it('fails if an invalid version string was passed to the constructor', async () => {
     try {
       // Pass an invalid version
@@ -530,4 +535,42 @@ describe('version', () => {
       expect.any(Object)
     )
   })
+
+  it('exists returns true if the tag exists', async () => {
+    // Mock the exec package to return the tag
+    const execMock = exec as jest.MockedFunction<typeof exec>
+    execMock.mockImplementation(
+      (
+        commandLine: string,
+        args?: string[],
+        options?: any
+      ): Promise<number> => {
+        options.listeners.stdout(Buffer.from('v1.2.3-alpha.4'))
+        return Promise.resolve(0)
+      }
+    )
+
+    const version = new Version('1.2.3-alpha.4')
+
+    expect(await version.exists(`${__dirname}/fixtures/valid`)).toBe(true)
+  })
+
+  it('exists returns false if the tag does not exist', async () => {
+    // Mock the exec package to return the tag
+    const execMock = exec as jest.MockedFunction<typeof exec>
+    execMock.mockImplementation(
+      (
+        commandLine: string,
+        args?: string[],
+        options?: any
+      ): Promise<number> => {
+        options.listeners.stdout(Buffer.from(''))
+        return Promise.resolve(0)
+      }
+    )
+
+    const version = new Version('1.2.3-alpha.4')
+
+    expect(await version.exists(`${__dirname}/fixtures/valid`)).toBe(false)
+  })
 })

action.yml

@@ -7,12 +7,17 @@ branding:
 
 inputs:
   manifest-path:
-    default: package.json
     description:
       The path to the manifest file that contains the version information,
       relative to the root of the repository. If not set, then `version` should
       be set to an explicit version in SemVer 2.0 format.
     required: false
+  overwrite:
+    default: 'false'
+    description:
+      If tags already exist for the specified or inferred version, setting this
+      to 'true' will overwrite them. Defaults to 'false'.
+    required: false
   ref:
     default: ${{ github.base_ref }}
     description:

package.json

@@ -1,7 +1,7 @@
 {
   "name": "semver",
   "description": "Semantically version GitHub repository tags",
-  "version": "0.1.2",
+  "version": "0.2.0",
   "author": "Nick Alteen <[email protected]>",
   "homepage": "https://github.com/issue-ops/semver#readme",
   "repository": {

src/main.ts

@@ -3,6 +3,7 @@ import { Version } from './version'
 
 export async function run() {
   const manifestPath: string = core.getInput('manifest-path')
+  const overwrite: boolean = core.getInput('overwrite') === 'true'
   const ref: string = core.getInput('ref')
   const useVersion: string = core.getInput('use-version')
   const workspace: string = core.getInput('workspace')
@@ -31,12 +32,17 @@ export async function run() {
     return
   }
 
+  // Check if the tags already exist in the repository.
+  if (!overwrite && (await version.exists(workspace))) {
+    core.setFailed("Version already exists and 'overwrite' is false")
+    return
+  }
+
   core.info(`Inferred Version: ${version.toString()}`)
   core.info(`Tagging ${ref} with version ${version.toString()}`)
 
   // Tag and push the version in the workspace
   await version.tag(ref, workspace)
-
   core.info('Tagging complete')
 
   // Output the various version formats

src/version.ts

@@ -22,6 +22,9 @@ export class Version {
   constructor(version: string) {
     core.info(`Input version string: ${version}`)
 
+    if (version.startsWith('v') || version.startsWith('V'))
+      version = version.slice(1)
+
     // Build metadata is separated by a `+`
     // https://semver.org/#spec-item-10
     // TODO: Would we eventually want to support this?
@@ -231,4 +234,28 @@ export class Version {
     if (tagOptions.stderr.includes('[new tag]') === false)
       throw new Error(tagOptions.stderr)
   }
+
+  /**
+   * Checks if the version tags already exist in the repository
+   *
+   * @param manifestPath The path to the manifest file
+   * @param workspace The project workspace
+   * @returns True if the version tags exist, otherwise false
+   */
+  async exists(workspace: string): Promise<boolean> {
+    // There's no need to check for anything other than the "full" tag (with the
+    // prerelease, if present). The major.minor or major tags may exist and can
+    // be moved.
+    core.info(`Checking for tag: v${this.toString(true)}`)
+
+    const tagOptions: TagOptions = new TagOptions(workspace)
+
+    await exec(`git tag -l "${this.toString(true)}"`, [], tagOptions.options)
+
+    core.debug(`STDOUT: ${tagOptions.stdout}`)
+    core.debug(`STDERR: ${tagOptions.stderr}`)
+
+    if (tagOptions.stdout.includes(this.toString(true))) return true
+    else return false
+  }
 }