Merge pull request #32 from michmich112/develop Release 1.1.0

Release 1.1.0

Author: michmich112

README.md

@@ -48,6 +48,10 @@ Example: `main.secondary[->patch]`.\
 If we have `main:1`, `secondary:0` ,`patch:0` the resulting version printout will be `1.0`.\
 If `patch:1` the resulting version printout will be `1.0->1`.
 
+
+#### **Optional**: `skip`
+Adds [SKIP] prefix to the commit message to prevent CI/CD build.
+
 #### **Required**: `version-file`
 File path where the current version can be found.
 
@@ -199,6 +203,9 @@ interface BumperOptionsFile {
     
     // use for custom scheme definitions
     schemeDefinition?: string,
+
+    // Add the [SKIP] prefix to skip build
+    skip?: boolean,
     
     // path file containing the current version
     // may include line if other possible matches
@@ -223,6 +230,11 @@ interface BumpRule {
      * What items in the version number need to be bumped
      */
     bump?: string | string[],
+  
+    /**
+     * Prefix to apply on the new version
+     */
+    prefix?: string,
 
     /**
      * Reset elements in the version number
@@ -232,6 +244,11 @@ interface BumpRule {
      * => 1.2.0
      */
     reset?: string | string[],
+  
+    /**
+     * Suffix to apply on the new version
+     */
+    suffix?: string,
 
     /**
      * Indicate that this bump should add a tag to the commit with the new version number
@@ -248,4 +265,10 @@ interface BumpRule {
 ```
 
 # Contributors
-Thank you to [jamieleecho](https://github.com/jamieleecho) for their help and contributions to the project!
+Thank you to 
+- [jamieleecho](https://github.com/jamieleecho)
+- [migueltarga](https://github.com/migueltarga)
+for their help and contributions to the project!
+
+# Notes
+This action uses the `gh-action-stats` package to track usage. See the data collected at [gh-action-stats-js](https://github.com/michmich112/gh-action-stats-js).

action.yml

@@ -25,6 +25,9 @@ inputs:
   rules:
     description: 'List of versioning rules'
     required: false
+  skip:
+    description: 'Adds [SKIP] prefix to the commit message to prevent CI/CD build'
+    required: false
   # Github token to commit the bumps
   github-token:
     description: 'Authorized github token'

dist/index.js

@@ -40,13 +40,15 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const core = __importStar(require("@actions/core"));
 const fs = __importStar(require("fs"));
+const gh_action_stats_1 = __importDefault(require("gh-action-stats"));
 const options_1 = require("./utils/options");
 const readline = __importStar(require("readline"));
 const gitUtils_1 = require("./utils/gitUtils");
 const Git_1 = __importDefault(require("./lib/Git"));
 const SUCCESS = 0, FAILURE = 1;
 function main() {
     return __awaiter(this, void 0, void 0, function* () {
+        gh_action_stats_1.default();
         if (!core.getInput('github-token')) {
             core.error("Github token required");
             return FAILURE;
@@ -63,7 +65,7 @@ function main() {
             const GIT_OPTIONS = {
                 userName: 'version-bumper',
                 userEmail: 'bumper@boringday.co',
-                message: `Updated version ${state.curVersion} -> ${state.newVersion}.`,
+                message: state.skip ? '[SKIP] ' : '' + `Updated version ${state.curVersion} -> ${state.newVersion}.`,
                 tag: state.tag ? { name: state.newVersion } : undefined,
                 token: core.getInput('github-token'),
                 branch: state.branch

dist/tests/util.test.js

@@ -333,6 +333,83 @@ describe("Get Current version from files", () => {
             expect(e.message).toBe(`No match found in file. Unable to identify current version number.`);
         }
     }));
+    describe("Get current version with prefix", () => {
+        let filePath = "./src/tests/assets/INTEGRATION_VERSION.txt", options = {
+            scheme: "org_semantic",
+            versionFile: { path: filePath, line: 4 },
+            files: [],
+            rules: [
+                {
+                    prefix: "v.",
+                    branch: "prefix_1_branch",
+                    bump: "build",
+                    trigger: "commit"
+                },
+                {
+                    prefix: "alpha.",
+                    branch: "prefix_2_branch",
+                    bump: "minor",
+                    trigger: "commit"
+                },
+                {
+                    suffix: "-ALPHA",
+                    branch: "suffix_1_branch",
+                    bump: "build",
+                    trigger: "commit"
+                },
+                {
+                    suffix: "rc",
+                    branch: "suffix_2_branch",
+                    bump: "minor",
+                    trigger: "commit"
+                }
+            ]
+        };
+        test("Get current version that has Prefix 1", () => __awaiter(void 0, void 0, void 0, function* () {
+            const version = yield utils_1.getCurVersion(options);
+            expect(version).toBe("v.1.0.2");
+        }));
+        test("Get current version that has Prefix 2", () => __awaiter(void 0, void 0, void 0, function* () {
+            options.versionFile.line = 5;
+            const version = yield utils_1.getCurVersion(options);
+            expect(version).toBe("alpha.2.3.5");
+        }));
+        test("Get correct version that has both prefixes in front", () => __awaiter(void 0, void 0, void 0, function* () {
+            options.versionFile.line = 6;
+            const version = yield utils_1.getCurVersion(options);
+            expect(version).toBe("v.2.3.5");
+        }));
+        test("Get current version that has Suffix 1", () => __awaiter(void 0, void 0, void 0, function* () {
+            options.versionFile.line = 7;
+            const version = yield utils_1.getCurVersion(options);
+            expect(version).toBe("2.3.5-ALPHA");
+        }));
+        test("Get current version that has Suffix 2", () => __awaiter(void 0, void 0, void 0, function* () {
+            options.versionFile.line = 8;
+            const version = yield utils_1.getCurVersion(options);
+            expect(version).toBe("6.7.8rc");
+        }));
+        test("Get current version that has Prefix 1 and Suffix 1", () => __awaiter(void 0, void 0, void 0, function* () {
+            options.versionFile.line = 9;
+            const version = yield utils_1.getCurVersion(options);
+            expect(version).toBe("v.1.0.2-ALPHA");
+        }));
+        test("Get current version that has Prefix 1 and Suffix 2", () => __awaiter(void 0, void 0, void 0, function* () {
+            options.versionFile.line = 10;
+            const version = yield utils_1.getCurVersion(options);
+            expect(version).toBe("v.4.5.6rc");
+        }));
+        test("Get current version that has Prefix 2 and Suffix 1", () => __awaiter(void 0, void 0, void 0, function* () {
+            options.versionFile.line = 11;
+            const version = yield utils_1.getCurVersion(options);
+            expect(version).toBe("alpha.3.5.6-ALPHA");
+        }));
+        test("Get current version that has Prefix 2 and Suffix 2", () => __awaiter(void 0, void 0, void 0, function* () {
+            options.versionFile.line = 12;
+            const version = yield utils_1.getCurVersion(options);
+            expect(version).toBe("alpha.7.8.9rc");
+        }));
+    });
 });
 describe("Get optional version items", () => {
     test("No Optional case.", () => {
@@ -567,6 +644,20 @@ describe("Bump Version tests", () => {
                     branch: 'master',
                     bump: 'major',
                     reset: ['minor', 'build']
+                },
+                // on commit to release-candidate branch, bump major, reset minor and build, add -rc as suffix
+                {
+                    trigger: 'commit',
+                    branch: 'release-candidate',
+                    bump: 'major',
+                    reset: ['minor', 'build'],
+                    suffix: "-rc"
+                },
+                // on commit to branch version-tag, add prefix: v.
+                {
+                    trigger: 'commit',
+                    branch: 'version-tag',
+                    prefix: "v."
                 }
             ]
         };
@@ -631,6 +722,16 @@ describe("Bump Version tests", () => {
             let newVersion = yield utils_1.bumpVersion(options, 'manual', 'master');
             expect(newVersion).toBe('2.0.1');
         }));
+        test("Commit trigger with suffix", () => __awaiter(void 0, void 0, void 0, function* () {
+            options.versionFile.line = 1;
+            let newVersion = yield utils_1.bumpVersion(options, 'commit', 'release-candidate');
+            expect(newVersion).toBe('2.0.1-rc');
+        }));
+        test("Commit trigger with prefix", () => __awaiter(void 0, void 0, void 0, function* () {
+            options.versionFile.line = 1;
+            let newVersion = yield utils_1.bumpVersion(options, 'commit', 'version-tag');
+            expect(newVersion).toBe("v.1.2.4");
+        }));
         // describe("Pull-request trigger tests", () => {});
         // describe("Comment trigger", () => {});
     });

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.getBranchFromTrigger = exports.getSchemeDefinition = exports.normalizeOptions = void 0;
+exports.getBumperState = exports.getTrigger = exports.normalizeFiles = exports.getSkipOption = 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"));
@@ -101,7 +101,7 @@ exports.getBranchFromTrigger = getBranchFromTrigger;
  */
 function getBumperOptions() {
     return __awaiter(this, void 0, void 0, function* () {
-        const optionsFile = core.getInput('options-file'), scheme = core.getInput('scheme'), customScheme = core.getInput('custom-scheme'), versionFile = core.getInput('version-file'), files = core.getInput('files'), rules = core.getInput('rules');
+        const optionsFile = core.getInput('options-file'), scheme = core.getInput('scheme'), skip = core.getInput('skip'), customScheme = core.getInput('custom-scheme'), versionFile = core.getInput('version-file'), files = core.getInput('files'), rules = core.getInput('rules');
         let error = ""; // error message
         let bumperOptions = {};
         let err = (message) => {
@@ -209,6 +209,14 @@ function getFiles(options) {
     return normalizeFiles(options.files);
 }
 exports.getFiles = getFiles;
+/**
+ * Check if should add [SKIP] prefix
+ * @param options {skip}
+ */
+function getSkipOption(options) {
+    return options.skip || false;
+}
+exports.getSkipOption = getSkipOption;
 /**
  * Normalize the file format
  * @param files
@@ -257,10 +265,11 @@ exports.getTrigger = getTrigger;
  */
 function getBumperState(options) {
     return __awaiter(this, void 0, void 0, function* () {
-        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 trigger = getTrigger(), branch = getBranchFromTrigger(trigger), skip = getSkipOption(options), 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,
+            skip,
             schemeRegExp,
             schemeDefinition,
             tag,