@ondrejbelza/semantic-release-jira 1.3.4 → 1.4.0

package/dist/consts.d.ts

@@ -0,0 +1,2 @@
+export declare const DEFAULT_VERSION_TEMPLATE = "v${version}";
+export declare const DEFAULT_RELEASE_DESCRIPTION_TEMPLATE = "Automated release with semantic-release-jira-releases https://git.io/JvAbj";

package/dist/consts.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DEFAULT_RELEASE_DESCRIPTION_TEMPLATE = exports.DEFAULT_VERSION_TEMPLATE = void 0;
+exports.DEFAULT_VERSION_TEMPLATE = "v${version}";
+exports.DEFAULT_RELEASE_DESCRIPTION_TEMPLATE = "Automated release with semantic-release-jira-releases https://git.io/JvAbj";

package/dist/index.d.ts

@@ -1,2 +1,3 @@
 import { verifyConditions } from "./verify_condition";
-export { verifyConditions };
+import { success } from "./success";
+export { verifyConditions, success };

package/dist/index.js

@@ -1,5 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.verifyConditions = void 0;
+exports.success = exports.verifyConditions = void 0;
 const verify_condition_1 = require("./verify_condition");
 Object.defineProperty(exports, "verifyConditions", { enumerable: true, get: function () { return verify_condition_1.verifyConditions; } });
+const success_1 = require("./success");
+Object.defineProperty(exports, "success", { enumerable: true, get: function () { return success_1.success; } });

package/dist/success.d.ts

@@ -0,0 +1,3 @@
+import { PluginConfig } from "./types";
+import { SuccessContext } from "semantic-release";
+export declare function success(config: PluginConfig, context: SuccessContext): Promise<void>;

package/dist/success.js

@@ -0,0 +1,133 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.success = success;
+const utils_1 = require("./utils");
+const _ = __importStar(require("lodash"));
+const consts_1 = require("./consts");
+const jira_client_1 = require("./jira-client");
+const p_limit_1 = __importDefault(require("p-limit"));
+const error_1 = __importDefault(require("@semantic-release/error"));
+function getMentionedTickets(ticketPrefix, commits, logger) {
+    const tickets = new Set();
+    const pattern = new RegExp(`\\b${(0, utils_1.escapeRegExp)(ticketPrefix)}-(\\d+)\\b`, "giu");
+    for (const commit of commits) {
+        const matches = commit.message.match(pattern);
+        if (matches) {
+            for (const match of matches) {
+                tickets.add(match);
+                logger.info(`Found matching ticket it commit ${match} in ${commit.commit.short}`);
+            }
+        }
+    }
+    return [...tickets];
+}
+async function findOrCreateVersion(c, projectKey, newVersionName, newVersionDescription, logger) {
+    const versions = await c.projectVersions.getProjectVersions({
+        projectIdOrKey: projectKey,
+    });
+    for (const v of versions) {
+        if (v.name === newVersionName) {
+            logger.info(`Found existing jira release with id: ${v.id}`);
+            return v;
+        }
+    }
+    return c.projectVersions.createVersion({
+        name: newVersionName,
+        description: newVersionDescription,
+        projectId: projectKey,
+        released: true,
+        releaseDate: new Date().toISOString(),
+    });
+}
+async function editIssueFixVersions(c, ticket, versionId, logger) {
+    logger.info(`Adding issue '${ticket}' to a release '${versionId}'`);
+    c.issues
+        .editIssue({
+        issueIdOrKey: ticket,
+        update: {
+            fixVersions: [
+                {
+                    add: { id: versionId },
+                },
+            ],
+        },
+    })
+        .catch((err) => {
+        const allowedStatusCodes = [400, 404];
+        let { statusCode } = err;
+        if (typeof err === "string") {
+            try {
+                err = JSON.parse(err);
+                statusCode = statusCode || err.statusCode;
+            }
+            catch {
+                // ignore
+            }
+        }
+        if (allowedStatusCodes.indexOf(statusCode) === -1) {
+            logger.error(`Issue '${ticket}' was not added to a release.`, err);
+            if (err.response) {
+                throw new error_1.default(err.Response);
+            }
+            throw new error_1.default(err);
+        }
+    })
+        .then(() => {
+        logger.complete(`Issue '${ticket}' was successfully added to a release.`);
+    });
+}
+async function success(config, context) {
+    const { env, logger, commits, nextRelease } = context;
+    const { jiraHost, project: projectKey, ticketPrefix, versionTemplate: definedVersionTemplate, } = config;
+    const tickets = getMentionedTickets(ticketPrefix, commits, logger);
+    const versionTemplate = _.template(definedVersionTemplate || consts_1.DEFAULT_VERSION_TEMPLATE);
+    const newVersionName = versionTemplate({ version: nextRelease.version });
+    const newVersionDescription = consts_1.DEFAULT_RELEASE_DESCRIPTION_TEMPLATE;
+    logger.info(`Using jira release '${newVersionName}'`);
+    logger.info(`using jira description '${consts_1.DEFAULT_RELEASE_DESCRIPTION_TEMPLATE}'`);
+    const c = (0, jira_client_1.CreateJiraClient)(logger, jiraHost, env.JIRA_EMAIL, env.JIRA_TOKEN);
+    const project = await c.projects.getProject({ projectIdOrKey: projectKey });
+    const version = await findOrCreateVersion(c, projectKey, newVersionName, newVersionDescription, logger);
+    const concurrentLimit = (0, p_limit_1.default)(10);
+    const edits = [];
+    for (const ticket of tickets) {
+        edits.push(concurrentLimit(() => editIssueFixVersions(c, ticket, version.id || "", logger)));
+    }
+    await Promise.all(edits);
+}

package/dist/types.d.ts

@@ -1,4 +1,6 @@
 export interface PluginConfig {
     jiraHost: string;
     project: string;
+    ticketPrefix: string;
+    versionTemplate: string;
 }

package/dist/utils.d.ts

@@ -0,0 +1 @@
+export declare function escapeRegExp(strIn: string): string;

package/dist/utils.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.escapeRegExp = escapeRegExp;
+function escapeRegExp(strIn) {
+    return strIn.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
+}

package/dist/verify_condition.js

@@ -12,8 +12,8 @@ const jira_client_1 = require("./jira-client");
  */
 async function verifyConditions(pluginConfig, context) {
     const { logger, env } = context;
+    const { jiraHost: host, project } = pluginConfig;
     logger.log("Checking conditions for my custom plugin...");
-    const host = pluginConfig.jiraHost;
     logger.log("jira host configure to:" + host);
     if (host == "") {
         throw new error_1.default("jira host configuration variable is missing.");
@@ -26,7 +26,7 @@ async function verifyConditions(pluginConfig, context) {
     }
     const c = (0, jira_client_1.CreateJiraClient)(logger, host, env.JIRA_EMAIL, env.JIRA_TOKEN);
     const p = await c.projects.getProject({
-        projectIdOrKey: pluginConfig.project,
+        projectIdOrKey: project,
     });
     logger.log("project was found and will be used:" + p.id);
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ondrejbelza/semantic-release-jira",
-  "version": "1.3.4",
+  "version": "1.4.0",
   "description": "semantic release jira releases plugin",
   "homepage": "https://github.com/mailstepcz/semantic-release-jira#readme",
   "bugs": {
@@ -29,6 +29,8 @@
   "dependencies": {
     "@semantic-release/error": "^4.0.0",
     "jira.js": "^5.2.2",
+    "lodash": "^4.17.21",
+    "p-limit": "^7.2.0",
     "semantic-release": "^25.0.2"
   },
   "devDependencies": {
@@ -37,6 +39,7 @@
     "@semantic-release/git": "^10.0.1",
     "@semantic-release/github": "^12.0.2",
     "@semantic-release/npm": "^13.1.3",
+    "@types/lodash": "^4.17.21",
     "@types/node": "^25.0.3",
     "@types/semantic-release__error": "^3.0.3",
     "@types/signale": "^1.4.7",