@ondrejbelza/semantic-release-jira 1.4.4 → 1.5.0

package/dist/consts.d.ts

@@ -1,2 +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";
+export declare const DEFAULT_RELEASE_DESCRIPTION_TEMPLATE = "# Release notes - {{version}}\n## Issues\n{{#each issues}}\n - [{{type}}] [{{ key }}]({{ link }}) {{ title }}\n  \n    Short description: {{ description }}\n  \n    Assigned to: {{ assignee }}\n{{/each}}\n\nRelease notes were automatically generated";

package/dist/consts.js

@@ -2,4 +2,14 @@
 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";
+exports.DEFAULT_RELEASE_DESCRIPTION_TEMPLATE = `# Release notes - {{version}}
+## Issues
+{{#each issues}}
+ - [{{type}}] [{{ key }}]({{ link }}) {{ title }}
+  
+    Short description: {{ description }}
+  
+    Assigned to: {{ assignee }}
+{{/each}}
+
+Release notes were automatically generated`;

package/dist/success.js

@@ -39,19 +39,35 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.success = success;
 const utils_1 = require("./utils");
 const _ = __importStar(require("lodash"));
+const handlebars_1 = __importDefault(require("handlebars"));
 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) {
+async function getIssueMetadata(c, issueKey, jiraHost, logger) {
+    logger.info(`Loading info for issue ${issueKey}`);
+    const issue = await c.issues.getIssue({ issueIdOrKey: issueKey });
+    return {
+        title: issue.fields.summary,
+        assignee: issue.fields.assignee.displayName || "unassigned",
+        description: _.truncate(issue.fields.description?.content?.[0]?.content?.[0].text, {
+            length: 100,
+        }),
+        key: issue.key,
+        link: `${jiraHost}/browse/${issue.key}`,
+        type: issue.fields.issuetype?.name || "unknown",
+    };
+}
+async function getMentionedTickets(c, ticketPrefix, jiraHost, 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}`);
+                const issue = await getIssueMetadata(c, match, jiraHost, logger);
+                tickets.add(issue);
             }
         }
     }
@@ -69,6 +85,9 @@ async function findOrCreateVersion(c, projectIdOrKey, newVersionName, newVersion
     }
     try {
         logger.info(`Creating new version in jira projectId: ${projectIdOrKey}, versionName: ${newVersionName}`);
+        logger.info(`Getting driver info`);
+        const driver = await c.myself.getCurrentUser();
+        logger.success(`Caller info acquired '${driver.name} / ${driver.emailAddress}'`);
         const version = await c.projectVersions.createVersion({
             name: newVersionName,
             description: newVersionDescription,
@@ -76,6 +95,7 @@ async function findOrCreateVersion(c, projectIdOrKey, newVersionName, newVersion
             released: true,
             releaseDate: new Date().toISOString(),
             archived: false,
+            driver: driver.accountId,
         });
         logger.success(`Created new jira version ${version.id}`);
         return version;
@@ -90,7 +110,7 @@ async function editIssueFixVersions(c, ticket, versionId, logger) {
     logger.info(`Adding issue '${ticket}' to a release '${versionId}'`);
     c.issues
         .editIssue({
-        issueIdOrKey: ticket,
+        issueIdOrKey: ticket.key,
         update: {
             fixVersions: [
                 {
@@ -126,13 +146,17 @@ async function editIssueFixVersions(c, ticket, versionId, logger) {
 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 c = (0, jira_client_1.CreateJiraClient)(logger, jiraHost, env.JIRA_EMAIL, env.JIRA_TOKEN);
+    const tickets = await getMentionedTickets(c, ticketPrefix, jiraHost, commits, logger);
     const versionTemplate = _.template(definedVersionTemplate || consts_1.DEFAULT_VERSION_TEMPLATE);
+    const descriptionTemplate = handlebars_1.default.compile(consts_1.DEFAULT_RELEASE_DESCRIPTION_TEMPLATE);
     const newVersionName = versionTemplate({ version: nextRelease.version });
-    const newVersionDescription = consts_1.DEFAULT_RELEASE_DESCRIPTION_TEMPLATE;
+    const newVersionDescription = descriptionTemplate({
+        version: newVersionName,
+        issues: tickets,
+    });
     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 });
     if (!project.id) {
         throw new error_1.default("Missing project id!");

package/dist/types.d.ts

@@ -4,3 +4,11 @@ export interface PluginConfig {
     ticketPrefix: string;
     versionTemplate: string;
 }
+export interface JiraIssue {
+    title: string;
+    key: string;
+    assignee: string;
+    type: string;
+    description: string;
+    link: string;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ondrejbelza/semantic-release-jira",
-  "version": "1.4.4",
+  "version": "1.5.0",
   "description": "semantic release jira releases plugin",
   "homepage": "https://github.com/mailstepcz/semantic-release-jira#readme",
   "bugs": {
@@ -28,6 +28,7 @@
   },
   "dependencies": {
     "@semantic-release/error": "^4.0.0",
+    "handlebars": "^4.7.8",
     "jira.js": "^5.2.2",
     "lodash": "^4.17.21",
     "p-limit": "^7.2.0",