@ondrejbelza/semantic-release-jira 1.7.1 → 1.8.0

package/README.md

@@ -63,11 +63,11 @@ interface Config {
   jiraHost: string;
 
   /**
-   * A prefixe to match when looking for tickets in commits.
+   * A list of prefixes to match when looking for tickets in commits.
    *
-   * ie. 'TEST' would match `TEST-123` and `TEST-456`
+   * ie. ['TEST'] would match `TEST-123` and `TEST-456`
    */
-  ticketPrefix: string;
+  ticketPrefixes: string[];
 
   /**
    * The id or key for the project releases will be created in

package/dist/consts.d.ts

@@ -1,2 +1,2 @@
 export declare const DEFAULT_VERSION_TEMPLATE = "v${version}";
-export declare const DEFAULT_RELEASE_DESCRIPTION_TEMPLATE = "# Release notes - {{version}}\n\n## Issues\n{{#each issues}}\n - [{{type}}] [{{ key }}]({{ link }}) {{ title }}\n   - Short description: {{ description }}\n   - Assigned to: {{ assignee }}\n\n{{/each}}\n\nRelease notes were automatically generated";
+export declare const DEFAULT_RELEASE_DESCRIPTION_TEMPLATE = "# Release notes - {{version}}\n\n\n## Issues:\n{{#each issues}}\n - [{{type}}] [{{ key }}]({{ link }}) {{ title }}\n   - Short description: {{ description }}\n   - Assigned to: {{ assignee }}\n\n{{/each}}\n\n\n## Commits not relevant to any Issue:\n{{#each commits}}\n - {{ message }}\n   - Committed by: {{ author }}\n\n{{/each}}\n\nRelease notes were automatically generated";

package/dist/consts.js

@@ -4,7 +4,8 @@ exports.DEFAULT_RELEASE_DESCRIPTION_TEMPLATE = exports.DEFAULT_VERSION_TEMPLATE
 exports.DEFAULT_VERSION_TEMPLATE = "v${version}";
 exports.DEFAULT_RELEASE_DESCRIPTION_TEMPLATE = `# Release notes - {{version}}
 
-## Issues
+
+## Issues:
 {{#each issues}}
  - [{{type}}] [{{ key }}]({{ link }}) {{ title }}
    - Short description: {{ description }}
@@ -12,4 +13,12 @@ exports.DEFAULT_RELEASE_DESCRIPTION_TEMPLATE = `# Release notes - {{version}}
 
 {{/each}}
 
+
+## Commits not relevant to any Issue:
+{{#each commits}}
+ - {{ message }}
+   - Committed by: {{ author }}
+
+{{/each}}
+
 Release notes were automatically generated`;

package/dist/success.js

@@ -58,20 +58,38 @@ async function getIssueMetadata(c, issueKey, jiraHost, logger) {
         type: issue.fields.issuetype?.name || "unknown",
     };
 }
-async function getMentionedTickets(c, ticketPrefix, jiraHost, commits, logger) {
+async function getContributions(c, ticketPrefixes, jiraHost, commits, logger) {
     const tickets = new Set();
-    const pattern = new RegExp(`\\b${(0, utils_1.escapeRegExp)(ticketPrefix)}-(\\d+)\\b`, "giu");
+    const releaseCommits = new Set();
+    const patterns = [];
+    for (const prefix of ticketPrefixes) {
+        const pattern = new RegExp(`\\b${(0, utils_1.escapeRegExp)(prefix)}-(\\d+)\\b`, "giu");
+        patterns.push(pattern);
+    }
     for (const commit of commits) {
-        const matches = commit.message.match(pattern);
-        if (matches) {
-            for (const match of matches) {
-                logger.info(`Found matching ticket it commit ${match} in ${commit.commit.short}`);
-                const issue = await getIssueMetadata(c, match, jiraHost, logger);
-                tickets.add(issue);
+        var found = false;
+        for (const pattern of patterns) {
+            const matches = commit.message.match(pattern);
+            if (matches) {
+                found = true;
+                for (const match of matches) {
+                    logger.info(`Found matching ticket it commit ${match} in ${commit.commit.short}`);
+                    const issue = await getIssueMetadata(c, match, jiraHost, logger);
+                    tickets.add(issue);
+                }
             }
         }
+        if (!found) {
+            releaseCommits.add({
+                author: commit.author.name,
+                message: commit.message,
+            });
+        }
     }
-    return [...tickets];
+    return {
+        commits: [...releaseCommits],
+        issues: [...tickets],
+    };
 }
 async function findOrCreateVersion(c, projectIdOrKey, newVersionName, newVersionDescription, logger) {
     const versions = await c.projectVersions.getProjectVersions({
@@ -107,7 +125,7 @@ async function findOrCreateVersion(c, projectIdOrKey, newVersionName, newVersion
     }
 }
 async function editIssueFixVersions(c, ticket, versionId, logger) {
-    logger.info(`Adding issue '${ticket}' to a release '${versionId}'`);
+    logger.info(`Adding issue '${ticket.key}' to a release '${versionId}'`);
     c.issues
         .editIssue({
         issueIdOrKey: ticket.key,
@@ -140,20 +158,21 @@ async function editIssueFixVersions(c, ticket, versionId, logger) {
         }
     })
         .then(() => {
-        logger.complete(`Issue '${ticket}' was successfully added to a release.`);
+        logger.complete(`Issue '${ticket.key}' 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 { jiraHost, project: projectKey, ticketPrefixes, versionTemplate: definedVersionTemplate, } = config;
     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 contributions = await getContributions(c, ticketPrefixes, 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 = descriptionTemplate({
         version: newVersionName,
-        issues: tickets,
+        issues: contributions.issues,
+        commits: contributions.commits,
     });
     logger.info(`Using jira release '${newVersionName}'`);
     logger.info(`using jira description '${consts_1.DEFAULT_RELEASE_DESCRIPTION_TEMPLATE}'`);
@@ -165,7 +184,7 @@ async function success(config, context) {
     const version = await findOrCreateVersion(c, project.id, newVersionName, newVersionDescription, logger);
     const concurrentLimit = (0, p_limit_1.default)(10);
     const edits = [];
-    for (const ticket of tickets) {
+    for (const ticket of contributions.issues) {
         edits.push(concurrentLimit(() => editIssueFixVersions(c, ticket, version.id || "", logger)));
     }
     await Promise.all(edits);

package/dist/types.d.ts

@@ -1,9 +1,13 @@
 export interface PluginConfig {
     jiraHost: string;
     project: string;
-    ticketPrefix: string;
+    ticketPrefixes: string[];
     versionTemplate: string;
 }
+export interface ReleaseCommit {
+    author: string;
+    message: string;
+}
 export interface JiraIssue {
     title: string;
     key: string;
@@ -12,3 +16,7 @@ export interface JiraIssue {
     description: string;
     link: string;
 }
+export interface ReleaseContributions {
+    commits: ReleaseCommit[];
+    issues: JiraIssue[];
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ondrejbelza/semantic-release-jira",
-  "version": "1.7.1",
+  "version": "1.8.0",
   "description": "semantic release jira releases plugin",
   "homepage": "https://github.com/mailstepcz/semantic-release-jira#readme",
   "bugs": {