Merge pull request #17 from michmich112/develop

Release 1.0.6

Author: michmich112

README.md

@@ -242,7 +242,7 @@ interface BumpRule {
     /**
      * Action that triggers the bump to occur
      */
-    trigger: 'commit' | 'pull-request' | 'pr-comment' | 'manual',
+    trigger: 'commit' | 'pull-request' | 'manual',
 
 }
 ```

dist/index.js

@@ -54,13 +54,17 @@ function main() {
         try {
             let options = yield options_1.getBumperOptions();
             let state = yield options_1.getBumperState(options);
+            if (state.curVersion === state.newVersion) {
+                core.info('No bump rules applicable');
+                return SUCCESS;
+            }
             yield new Git_1.default().checkoutBranch(state.branch);
             yield bump(state);
             const GIT_OPTIONS = {
                 userName: 'version-bumper',
                 userEmail: '[email protected]',
                 message: `Updated version ${state.curVersion} -> ${state.newVersion}.`,
-                tag: { name: state.newVersion },
+                tag: !state.tag ? { name: state.newVersion } : undefined,
                 token: core.getInput('github-token'),
                 branch: state.branch
             };

dist/rules/tests/isRuleApplicable.test.js

@@ -50,7 +50,7 @@ describe('[ RULE ] - isRuleApplicable', () => {
         const rule = {
             trigger: 'commit',
         };
-        const trigger = 'pr-comment';
+        const trigger = 'manual';
         const branch = 'randomBranch';
         expect(isRuleApplicable_1.default(rule, trigger, branch)).toBe(false);
     });

dist/utils/options.js

@@ -28,7 +28,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getBumperState = exports.getTrigger = exports.normalizeFiles = exports.getFiles = exports.getBumperOptions = exports.getBranchFromRef = exports.getSchemeDefinition = exports.normalizeOptions = void 0;
+exports.getBumperState = exports.getTrigger = exports.normalizeFiles = exports.getFiles = exports.getBumperOptions = exports.getBranchFromTrigger = exports.getSchemeDefinition = exports.normalizeOptions = void 0;
 const definedSchemes = __importStar(require("../schemes.json"));
 const utils_1 = require("./utils");
 const core = __importStar(require("@actions/core"));
@@ -74,13 +74,28 @@ function getSchemeDefinition(options) {
 exports.getSchemeDefinition = getSchemeDefinition;
 /**
  * Get Branch name from reference
- * @param ref
+ * Only tested with the GITHUB_REF env var
+ * @param trigger
  */
-function getBranchFromRef(ref) {
-    const refPath = ref.split('/');
-    return refPath[refPath.length - 1]; // last string in the ref is the branch name
+function getBranchFromTrigger(trigger) {
+    var _a;
+    let branch;
+    switch (trigger) {
+        case 'pull-request':
+            branch = process.env.GITHUB_HEAD_REF || '';
+            break;
+        case 'commit':
+        case 'manual':
+        default:
+            branch = ((_a = process.env.GITHUB_REF) === null || _a === void 0 ? void 0 : _a.substring('refs/heads/'.length)) || '';
+            break;
+    }
+    core.info(`process.env.GITHUB_HEAD_REF: ${process.env.GITHUB_HEAD_REF}`);
+    core.info(`process.env.GITHUB_REF: ${process.env.GITHUB_REF}`);
+    core.info(`Current Branch identified: ${branch}`);
+    return branch;
 }
-exports.getBranchFromRef = getBranchFromRef;
+exports.getBranchFromTrigger = getBranchFromTrigger;
 /**
  * Get all bumper options
  */
@@ -226,12 +241,12 @@ function getTrigger() {
             return 'commit';
         case 'pull_request':
             return 'pull-request';
-        case 'pull_request_review_comment':
-            return 'pr-comment';
+        // case 'pull_request_review_comment':
+        //   return 'pr-comment';
         case 'workflow_dispatch':
             return 'manual';
         default:
-            console.warn("Event trigger not of type: commit, pull request or pr-comment.");
+            console.warn("Event trigger not of type: commit, pull request or manual.");
             throw new Error("Invalid trigger event");
     }
 }
@@ -242,7 +257,7 @@ exports.getTrigger = getTrigger;
  */
 function getBumperState(options) {
     return __awaiter(this, void 0, void 0, function* () {
-        const branch = getBranchFromRef(process.env.GITHUB_REF || ''), schemeRegExp = utils_1.getSchemeRegex(options), schemeDefinition = getSchemeDefinition(options), curVersion = yield utils_1.getCurVersion(options), trigger = getTrigger(), tag = utils_1.getTag(options, trigger, branch), newVersion = yield utils_1.bumpVersion(options, trigger, branch), files = getFiles(options);
+        const trigger = getTrigger(), branch = getBranchFromTrigger(trigger), schemeRegExp = utils_1.getSchemeRegex(options), schemeDefinition = getSchemeDefinition(options), curVersion = yield utils_1.getCurVersion(options), tag = utils_1.getTag(options, trigger, branch), newVersion = yield utils_1.bumpVersion(options, trigger, branch), files = getFiles(options);
         const state = {
             curVersion,
             newVersion,
@@ -253,7 +268,7 @@ function getBumperState(options) {
             branch,
             files
         };
-        console.log(`State -> ${JSON.stringify(state)}`);
+        core.info(`State -> ${JSON.stringify(state)}`);
         return state;
     });
 }

src/index.ts

@@ -25,14 +25,18 @@ async function main() {
 
     let state: BumperState = await getBumperState(options);
 
+    if(state.curVersion === state.newVersion) {
+      core.info('No bump rules applicable');
+      return SUCCESS;
+    }
     await new Git().checkoutBranch(state.branch);
     await bump(state);
 
     const GIT_OPTIONS: CommitOptions = {
       userName: 'version-bumper',
       userEmail: '[email protected]',
       message: `Updated version ${state.curVersion} -> ${state.newVersion}.`,
-      tag: { name: state.newVersion },
+      tag: !state.tag ? { name: state.newVersion } : undefined,
       token: core.getInput('github-token'),
       branch: state.branch
     };

src/lib/types/OptionsFile.types.ts

@@ -68,7 +68,7 @@ export interface BumpRule {
      * Comment that triggers the rule
      * Only used when the trigger is pr-comment
      */
-    comment?: string,
+    // comment?: string,
 
     /**
      * Allows the bumper to create a commit tag for the bump
@@ -103,7 +103,7 @@ export interface BumpRule {
 }
 
 export type VersionScheme = 'custom' | any;
-export type RuleTrigger = 'commit' | 'pull-request' | 'pr-comment' | 'manual';
+export type RuleTrigger = 'commit' | 'pull-request' | 'manual'; //| 'pr-comment'
 export type VersionReleaseStatus = 'alpha' | 'beta' | 'release-candidate' | 'release';
 export type Seperators = '.' | ',' | ';' | ':' | '-' | '_' | '>' | '<';
 export const seperators: Seperators[] = ['.' , ',' , ';' , ':' , '-' , '_' , '>' , '<'];

src/rules/tests/isRuleApplicable.test.ts

@@ -51,7 +51,7 @@ describe('[ RULE ] - isRuleApplicable', () => {
     const rule: BumpRule = {
       trigger: 'commit',
     };
-    const trigger: RuleTrigger = 'pr-comment';
+    const trigger: RuleTrigger = 'manual';
     const branch = 'randomBranch';
     expect(isRuleApplicable(rule, trigger, branch)).toBe(false);
   });

src/utils/options.ts

@@ -7,7 +7,6 @@ import * as core from '@actions/core';
 import * as github from '@actions/github';
 import * as fs from "fs";
 
-
 /**
  * Normalizes options by associating the scheme if user has selected a preset scheme
  * @param options
@@ -44,11 +43,25 @@ export function getSchemeDefinition(options: BumperOptionsFile): string {
 
 /**
  * Get Branch name from reference
- * @param ref
+ * Only tested with the GITHUB_REF env var
+ * @param trigger
  */
-export function getBranchFromRef(ref: string): string {
-  const refPath = ref.split('/');
-  return refPath[refPath.length - 1]; // last string in the ref is the branch name
+export function getBranchFromTrigger(trigger: RuleTrigger): string {
+  let branch: string;
+  switch (trigger) {
+    case 'pull-request':
+      branch = process.env.GITHUB_HEAD_REF || '';
+      break;
+    case 'commit':
+    case 'manual':
+    default:
+      branch = process.env.GITHUB_REF?.substring('refs/heads/'.length) || '';
+      break;
+  }
+  core.info(`process.env.GITHUB_HEAD_REF: ${process.env.GITHUB_HEAD_REF}`);
+  core.info(`process.env.GITHUB_REF: ${process.env.GITHUB_REF}`);
+  core.info(`Current Branch identified: ${branch}`);
+  return branch;
 }
 
 /**
@@ -188,12 +201,12 @@ export function getTrigger(): RuleTrigger {
       return 'commit';
     case 'pull_request':
       return 'pull-request';
-    case 'pull_request_review_comment':
-      return 'pr-comment';
+    // case 'pull_request_review_comment':
+    //   return 'pr-comment';
     case 'workflow_dispatch':
       return 'manual';
     default:
-      console.warn("Event trigger not of type: commit, pull request or pr-comment.");
+      console.warn("Event trigger not of type: commit, pull request or manual.");
       throw new Error("Invalid trigger event");
   }
 }
@@ -203,11 +216,11 @@ export function getTrigger(): RuleTrigger {
  * @param options
  */
 export async function getBumperState(options: BumperOptionsFile): Promise<BumperState> {
-  const branch = getBranchFromRef(process.env.GITHUB_REF || ''),
+  const trigger: RuleTrigger = getTrigger(),
+    branch = getBranchFromTrigger(trigger),
     schemeRegExp = getSchemeRegex(options),
     schemeDefinition = getSchemeDefinition(options),
     curVersion = await getCurVersion(options),
-    trigger: RuleTrigger = getTrigger(),
     tag: boolean = getTag(options, trigger, branch),
     newVersion = await bumpVersion(options, trigger, branch),
     files = getFiles(options);
@@ -221,6 +234,6 @@ export async function getBumperState(options: BumperOptionsFile): Promise<Bumper
     branch,
     files
   };
-  console.log(`State -> ${JSON.stringify(state)}`);
+  core.info(`State -> ${JSON.stringify(state)}`);
   return state;
 }