feat: introduces tag creation for hot fix releases

bin/index.js

@@ -7,6 +7,7 @@ const flow = require('./utils/flow.js');
 const options = require('./utils/command.js').options;
 const templateUtils = require('./utils/template-utils.js');
 const boxen = require('boxen');
+const { exec } = require('child_process');
 
 runYaba();
 
@@ -17,18 +18,21 @@ async function runYaba() {
         // https://www.npmjs.com/package/tiny-updater OR https://www.npmjs.com/package/update-notifier
         // can be used instead below method.
 
-        await tool.checkUpdate(); // check if the yaba cli has newer version
+        // check if the yaba cli has newer version
+        await tool.checkUpdate();
+
         // check required ENV variables
-
         flow.checkRequiredEnvVariables();
+
         // check if the current directory is git repo
+        checkDirectory();
 
-        checkDirectory()
         // check internet connection
-
         await flow.checkInternetConnection();
-        // prepare username, repoOwner and releaseRepo
 
+        checkHotfixRelease();
+
+        // prepare username, repoOwner and releaseRepo
         const username = await flow.retrieveUsername();
         const repoOwner = helper.retrieveOwner(options.owner, username);
         const releaseRepo = helper.retrieveReleaseRepo(options.repo);
@@ -44,7 +48,7 @@ async function runYaba() {
 
         // show only changelog
         if (canShowChangelog(changeLog)) {
-            printChangelog(releaseRepo, changeLog);
+            printChangelog(changeLog);
         }
 
         // create the release
@@ -67,9 +71,9 @@ async function prepareRelease(changeLog, repoOwner, releaseRepo, lastReleaseTag)
     if (hasReleaseCreatePermission) {
         let preparedChangeLog = helper.prepareChangeLog(options.body, changeLog);
         let changeLogDetails = templateUtils.generateChangelog(preparedChangeLog, repoOwner, releaseRepo, lastReleaseTag, helper.releaseTagName(options.tag));
-        let releaseName = helper.releaseName(options.releaseName)
+        let releaseName = helper.releaseName(options.releaseName, options.hotfix);
         const releaseUrl = await flow.createRelease(repoOwner, releaseRepo, options.draft, releaseName,
-            changeLogDetails, options.tag);
+            changeLogDetails, options.tag, options.hotfix);
 
         // play yaba sound if the release successfully created
         helper.playSound(options.sound);
@@ -99,7 +103,28 @@ function checkDirectory() {
     }
 }
 
-function printChangelog(repoName, changeLog) {
+function checkHotfixRelease() {
+    // check if the current branch is not main/master and command has hotfix flag    
+    exec('git branch --show-current', (err, stdout, stderr) => {
+        if (err) {
+            console.log(`An error occurred: ${err.message}`);
+            process.exit();
+        }
+
+        if (stderr) {
+            console.error(`An error occurred: ${stderr}`);
+            process.exit();
+        }
+
+        const currentBranch = stdout.trim();
+        if (currentBranch === 'master' || currentBranch === 'main') {
+            console.log(kleur.red("you can not create hotfix from main or master branches!"));
+            process.exit();
+        }
+    });
+}
+
+function printChangelog(changeLog) {
     const changelogBoxOptions = {
         padding: 1,
         title: 'Changelog',

bin/utils/command.js

@@ -19,6 +19,11 @@ const commands = yargs
         describe: "Creates the release as draft.",
         type: "boolean"
     })
+    .option("f", {
+        alias: "hotfix",
+        describe: "Prepares the release with hotfix tag.",
+        type: "boolean"
+    })
     .option("c", {
         alias: "changelog",
         describe: "Shows only changelog without creating the release.",

bin/utils/flow.js

@@ -169,9 +169,10 @@ module.exports = {
      * @param name the name/title of the release
      * @param body the changelog to be defined in the release
      * @param tag_name the tag name
+     * @param hotfix checks if the tag name must be created as hotfix or not
      * @returns {Promise<void>}
      */
-    createRelease: async function (owner, repo, draft, name, body, tag_name) {
+    createRelease: async function (owner, repo, draft, name, body, tag_name, hotfix) {
 
         try {
             spinner.start('Preparing the release...');
@@ -180,9 +181,9 @@ module.exports = {
                 owner: owner,
                 repo: repo,
                 draft: draft,
-                name: helper.releaseName(name),
+                name: name,
                 body: body,
-                tag_name: helper.releaseTagName(tag_name)
+                tag_name: helper.releaseTagName(tag_name, hotfix)
             });
 
             // if the user terminal supports hyperlink, this will be a clickable link, otherwise prints plain text.

bin/utils/helper.js

@@ -22,12 +22,16 @@ module.exports = {
      * this prepares the tag name in 'prod_global_yyyy-MM-dd.1' format.
      *
      * @param tagName the given tag name
+     * @param hotfix checks if the tag name must be created as hotfix or not
      * @returns {string|*} the prepared tag name
      */
-    releaseTagName: function (tagName) {
+    releaseTagName: function (tagName, hotfix) {
 
         if (stringUtils.isBlank(tagName)) {
             const currentDate = format(new Date(), constants.TAG_DATE_FORMAT);
+            if (hotfix) {
+                return `hotfix_prod_globl_${currentDate}.1`;
+            }
             return `prod_global_${currentDate}.1`;
         }
 
@@ -38,10 +42,15 @@ module.exports = {
      * prepares the title of the release. if the given {@code name} is blank, this prepares
      * the title in 'Global release yyyy-MM-dd' format.
      * @param name the given release name
+     * @param hotfix checks if the release name must be created as hotfix or not
      * @returns {string|*}
      */
-    releaseName: function (name) {
-        return stringUtils.isBlank(name) ? `Global release ${this.releaseDate()}` : name;
+    releaseName: function (name, hotfix) {
+        if(stringUtils.isBlank(name)) {
+            let releaseName = `Global release ${this.releaseDate()}`;
+            return hotfix ? 'Hotfix - ' + releaseName : releaseName;
+        }
+        return name;
     },
 
     /**