include version in requests

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

@@ -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]
     })
 

dist/index.js.map

@@ -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]
     })