Updated input param name

Changed INPUT_UPDATE_TYPE to INPUT_RELEASE_TYPE for consistency
teqbench · Sep 22, 2023 · d5dad9c · d5dad9c
1 parent cf42955
commit d5dad9c
Show file tree

Hide file tree

Showing 4 changed files with 34 additions and 34 deletions.
diff --git a/__tests__/main.test.ts b/__tests__/main.test.ts
@@ -25,7 +25,7 @@ describe('action', () => {
     // Set the action's inputs as return values from core.getInput()
     getInputMock.mockImplementation((name: string): string => {
       switch (name) {
-        case 'INPUT_UPDATE_TYPE':
+        case 'INPUT_RELEASE_TYPE':
           return 'MAJOR'
         case 'INPUT_VERSION_JSON':
           return '{"major":31,"minor":1,"patch":0,"build":457,"revision":0,"versionSuffix":"alpha"}'
@@ -42,7 +42,7 @@ describe('action', () => {
     // Set the action's inputs as return values from core.getInput()
     getInputMock.mockImplementation((name: string): string => {
       switch (name) {
-        case 'INPUT_UPDATE_TYPE':
+        case 'INPUT_RELEASE_TYPE':
           return 'MAJOR'
         case 'INPUT_VERSION_JSON':
           return '{"major":31,"minor":1,"patch":0,"build":457,"revision":0,"versionSuffix":"alpha"}'
@@ -59,7 +59,7 @@ describe('action', () => {
     // Set the action's inputs as return values from core.getInput()
     getInputMock.mockImplementation((name: string): string => {
       switch (name) {
-        case 'INPUT_UPDATE_TYPE':
+        case 'INPUT_RELEASE_TYPE':
           return 'MINOR'
         case 'INPUT_VERSION_JSON':
           return '{"major":31,"minor":1,"patch":0,"build":457,"revision":0,"versionSuffix":"alpha"}'
@@ -76,7 +76,7 @@ describe('action', () => {
     // Set the action's inputs as return values from core.getInput()
     getInputMock.mockImplementation((name: string): string => {
       switch (name) {
-        case 'INPUT_UPDATE_TYPE':
+        case 'INPUT_RELEASE_TYPE':
           return 'PATCH'
         case 'INPUT_VERSION_JSON':
           return '{"major":31,"minor":1,"patch":0,"build":457,"revision":0,"versionSuffix":"alpha"}'
@@ -93,7 +93,7 @@ describe('action', () => {
     // Set the action's inputs as return values from core.getInput()
     getInputMock.mockImplementation((name: string): string => {
       switch (name) {
-        case 'INPUT_UPDATE_TYPE':
+        case 'INPUT_RELEASE_TYPE':
           return 'invalid'
         case 'INPUT_VERSION_JSON':
           return '{"major":31,"minor":1,"patch":0,"build":457,"revision":0,"versionSuffix":"alpha"}'
@@ -116,7 +116,7 @@ describe('action', () => {
     // Set the action's inputs as return values from core.getInput()
     getInputMock.mockImplementation((name: string): string => {
       switch (name) {
-        case 'INPUT_UPDATE_TYPE':
+        case 'INPUT_RELEASE_TYPE':
           return 'MAJOR'
         case 'INPUT_VERSION_JSON':
           return 'this is not valid version json'

diff --git a/action.yml b/action.yml
@@ -4,7 +4,7 @@ author: "Teq Bench"
 
 # Define your inputs here.
 inputs:
-  INPUT_UPDATE_TYPE:
+  INPUT_RELEASE_TYPE:
     description: "Type of version update. Options: MAJOR, MINOR, PATCH."
     required: true
   INPUT_VERSION_JSON:

diff --git a/dist/index.js b/dist/index.js
diff --git a/src/main.ts b/src/main.ts
@@ -1,6 +1,15 @@
 import * as core from '@actions/core'
 
-enum VersionUpdateType {
+interface Version {
+  major: number
+  minor: number
+  patch: number
+  build: number
+  revision: number
+  suffix: string
+}
+
+enum VersionReleaseType {
   MAJOR = 'MAJOR',
   MINOR = 'MINOR',
   PATCH = 'PATCH'
@@ -16,9 +25,9 @@ export async function run(): Promise<void> {
     // error when trying to cast a string to the enum.
     // Per https://thoughtbot.com/blog/the-trouble-with-typescript-enums, what's implemented below
     // seems to be the best workaround
-    const updateType: VersionUpdateType | undefined = Object.values(
-      VersionUpdateType
-    ).find(x => x === core.getInput('INPUT_UPDATE_TYPE'))
+    const updateType: VersionReleaseType | undefined = Object.values(
+      VersionReleaseType
+    ).find(x => x === core.getInput('INPUT_RELEASE_TYPE'))
 
     if (updateType === undefined) {
       throw new Error('Update type is undefined')
@@ -38,23 +47,14 @@ export async function run(): Promise<void> {
 }
 
 async function processVersionJson(
-  updateType: VersionUpdateType
+  updateType: VersionReleaseType
 ): Promise<void> {
-  interface Version {
-    major: number
-    minor: number
-    patch: number
-    build: number
-    revision: number
-    suffix: string
-  }
-
   try {
     const version: Version = JSON.parse(core.getInput('INPUT_VERSION_JSON'))
 
     // NOTE: for Trading Toolbox, patch and reversion are the same.
     switch (updateType) {
-      case VersionUpdateType.MAJOR: {
+      case VersionReleaseType.MAJOR: {
         // Increment major version component is unchanged.
         // Reset minor, patch/revision to 0.
 
@@ -64,7 +64,7 @@ async function processVersionJson(
 
         break
       }
-      case VersionUpdateType.MINOR: {
+      case VersionReleaseType.MINOR: {
         // Major version component is unchanged.
         // Increment minor version component.
         // Reset patch/revision to 0.
@@ -74,7 +74,7 @@ async function processVersionJson(
 
         break
       }
-      case VersionUpdateType.PATCH: {
+      case VersionReleaseType.PATCH: {
         // Major version component is unchanged.
         // Minor version component is unchanged.
         // Incremment patch/revision.