Merge pull request #65 from github/version

Update Release + Versioning

Author: GrantBirki

__tests__/version.test.js

@@ -0,0 +1,34 @@
+import {VERSION} from '../src/version'
+
+describe('VERSION constant', () => {
+  const versionRegex = /^v(\d+)\.(\d+)\.(\d+)(?:-rc\.(\d+))?$/
+
+  it('should match the version pattern', () => {
+    expect(VERSION).toMatch(versionRegex)
+  })
+
+  it('should validate v1.0.0', () => {
+    const version = 'v1.0.0'
+    expect(version).toMatch(versionRegex)
+  })
+
+  it('should validate v4.5.1', () => {
+    const version = 'v4.5.1'
+    expect(version).toMatch(versionRegex)
+  })
+
+  it('should validate v10.123.44', () => {
+    const version = 'v10.123.44'
+    expect(version).toMatch(versionRegex)
+  })
+
+  it('should validate v1.1.1-rc.1', () => {
+    const version = 'v1.1.1-rc.1'
+    expect(version).toMatch(versionRegex)
+  })
+
+  it('should validate v15.19.4-rc.35', () => {
+    const version = 'v15.19.4-rc.35'
+    expect(version).toMatch(versionRegex)
+  })
+})

dist/index.js

@@ -9,23 +9,58 @@ RED='\033[0;31m'
 GREEN='\033[0;32m'
 BLUE='\033[0;34m'
 
-latest_tag=$(git describe --tags $(git rev-list --tags --max-count=1))
-echo -e "The latest release tag is: ${BLUE}${latest_tag}${OFF}"
-read -p 'New Release Tag (vX.X.X format): ' new_tag
+# Read the version from src/version.js
+version_file="src/version.js"
+if [[ ! -f $version_file ]]; then
+  echo -e "${RED}ERROR${OFF} - Version file not found: $version_file"
+  exit 1
+fi
+
+version_line=$(grep 'export const VERSION' $version_file)
+if [[ -z $version_line ]]; then
+  echo -e "${RED}ERROR${OFF} - Version line not found in: $version_file"
+  exit 1
+fi
+
+# Extract the version value
+new_tag=$(echo $version_line | sed -E "s/export const VERSION = '([^']+)'/\1/")
+if [[ -z $new_tag ]]; then
+  echo -e "${RED}ERROR${OFF} - Failed to extract version from: $version_file"
+  exit 1
+fi
 
-tag_regex='^v[0-9]+\.[0-9]+\.[0-9]+$'
-echo "$new_tag" | grep -E "$tag_regex"
+# Validate the version tag format
+tag_regex='^v[0-9]+\.[0-9]+\.[0-9]+(-rc\.[0-9]+)?$'
+echo "$new_tag" | grep -E "$tag_regex" > /dev/null
 
 if [[ $? -ne 0 ]]; then
-  echo -e "${RED}ERROR${OFF} - Tag: $new_tag is not valid. Please use vX.X.X format."
+  echo -e "${RED}ERROR${OFF} - Tag: $new_tag is not valid. Please use vX.X.X or vX.X.X-rc.X format."
   exit 1
 fi
 
+# Get the latest tag
+latest_tag=$(git describe --tags $(git rev-list --tags --max-count=1))
+echo -e "The latest release tag is: ${BLUE}${latest_tag}${OFF}"
+
+# Confirm the new tag
+read -p "New Release Tag (press ENTER for default: ${new_tag}): " input_tag
+new_tag=${input_tag:-$new_tag}
+
+# Tag the new release
 git tag -a $new_tag -m "$new_tag Release"
+if [[ $? -ne 0 ]]; then
+  echo -e "${RED}ERROR${OFF} - Failed to create tag: $new_tag"
+  exit 1
+fi
 
 echo -e "${GREEN}OK${OFF} - Tagged: $new_tag"
 
+# Push the tags to remote
 git push --tags
+if [[ $? -ne 0 ]]; then
+  echo -e "${RED}ERROR${OFF} - Failed to push tags to remote"
+  exit 1
+fi
 
 echo -e "${GREEN}OK${OFF} - Tags pushed to remote!"
 echo -e "${GREEN}DONE${OFF}"

dist/index.js.map

@@ -4,6 +4,7 @@ import * as github from '@actions/github'
 import {context} from '@actions/github'
 import {postReactions} from './post-reactions'
 import {octokitRetry} from '@octokit/plugin-retry'
+import {VERSION} from '../version'
 
 // Default failure reaction
 const thumbsDown = '-1'
@@ -38,6 +39,7 @@ export async function post() {
 
     // Create an octokit client with the retry plugin
     const octokit = github.getOctokit(token, {
+      userAgent: `github/command@${VERSION}`,
       additionalPlugins: [octokitRetry]
     })
 

script/release

@@ -10,10 +10,12 @@ import {actionStatus} from './functions/action-status'
 import {prechecks} from './functions/prechecks'
 import {post} from './functions/post'
 import {COLORS} from './functions/colors'
+import {VERSION} from './version'
 
 // :returns: 'success', 'failure', 'safe-exit' or raises an error
 export async function run() {
   try {
+    core.info(`🛸 github/command ${COLORS.info}${VERSION}${COLORS.reset}`)
     // Get the inputs for the 'command' Action
     const command = core.getInput('command', {required: true})
     const token = core.getInput('github_token', {required: true})
@@ -26,6 +28,7 @@ export async function run() {
 
     // create an octokit client with the retry plugin
     const octokit = github.getOctokit(token, {
+      userAgent: `github/command@${VERSION}`,
       additionalPlugins: [octokitRetry]
     })
 

src/functions/post.js

@@ -0,0 +1,9 @@
+// The version of the command Action
+// Acceptable version formats:
+// - v1.0.0
+// - v4.5.1
+// - v10.123.44
+// - v1.1.1-rc.1
+// - etc
+
+export const VERSION = 'v1.4.0'