feat: add ability to mark commit as breaking

Signed-off-by: Ardalan Amini <[email protected]>
ardalanamini · Apr 29, 2023 · f676806 · f676806
1 parent 4b435e2
commit f676806
Show file tree

Hide file tree

Showing 4 changed files with 28 additions and 8 deletions.
diff --git a/action/index.js b/action/index.js
diff --git a/action/index.js.map b/action/index.js.map
diff --git a/src/changelog.ts b/src/changelog.ts
@@ -48,6 +48,7 @@ interface ScopeGroupI {
 }
 
 interface LogI {
+  breaking: boolean;
   description: string;
   references: string[];
 }
@@ -97,7 +98,7 @@ export async function generateChangelog(lastSha?: string): Promise<string> {
 
       debug(`commit message -> ${ message }`);
 
-      let { type, scope, description, pr, flag } = parseCommitMessage(message);
+      let { type, scope, description, pr, flag, breaking } = parseCommitMessage(message);
 
       if (!description) continue;
 
@@ -138,6 +139,7 @@ export async function generateChangelog(lastSha?: string): Promise<string> {
 
       if (log == null) {
         log = {
+          breaking,
           description,
           references: [],
         };
@@ -179,8 +181,8 @@ export async function generateChangelog(lastSha?: string): Promise<string> {
         prefix = "  ";
       }
 
-      for (const { description, references } of logs) {
-        let line = `${ prefix }* ${ description }`;
+      for (const { breaking, description, references } of logs) {
+        let line = `${ prefix }* ${ breaking ? "**breaking: **" : "" }${ description }`;
 
         if (references.length > 0) line += ` (${ references.join(", ") })`;
 

diff --git a/src/utils/parse-commit-message.ts b/src/utils/parse-commit-message.ts
@@ -23,8 +23,26 @@
  *
  */
 
-const REGEX = /^(?<type>[^:()]*)(?:\((?<scope>[^()]*?)\)|): *(?<description>.+?) *(?:\(#(?<pr>[1-9]\d*?)\)|) *(?:\[(?<flag>[^[\]]*?)]|)\s*$/;
+const REGEX = /^(?<type>[^!:()]*)(?:\((?<scope>[^!()]*?)\)|)(?<breaking>!?): *(?<description>.+?) *(?:\(#(?<pr>[1-9]\d*?)\)|) *(?:\[(?<flag>[^[\]]*?)]|)\s*$/;
 
-export function parseCommitMessage(message: string): { description?: string; flag?: string; pr?: `${ number }`; scope?: string; type?: string } {
-  return REGEX.exec(message)?.groups ?? {};
+export function parseCommitMessage(message: string): ParsedCommitMessageI {
+  const { description, flag, pr, scope, type, breaking } = REGEX.exec(message)?.groups ?? {};
+
+  return {
+    breaking: !!breaking,
+    description,
+    flag,
+    pr,
+    scope,
+    type,
+  };
+}
+
+export interface ParsedCommitMessageI {
+  breaking: boolean;
+  description?: string;
+  flag?: string;
+  pr?: string;
+  scope?: string;
+  type?: string;
 }