Skip to content

Unexpected major release because commit description includes a line starting with "Breaking change" #776

Open
@brian-smith-tcril

Description

@brian-smith-tcril

It's possible there isn't a reasonable way to avoid this, but I recently encountered an issue where a commit message triggered a unexpected major release for me.

diff --git a/test/integration.test.js b/test/integration.test.js
index 112bc3a..550f9ee 100644
--- a/test/integration.test.js
+++ b/test/integration.test.js
@@ -25,6 +25,24 @@ test('Parse with "conventional-changelog-angular" by default', async (t) => {
   t.true(t.context.log.calledWith("Analysis of %s commits complete: %s release", 2, "minor"));
 });
 
+test('Parse with "conventional-changelog-angular" by default 2', async (t) => {
+  const commits = [
+    {
+      hash: "456",
+      message: `feat: new feature
+
+      Breaking change for unsupported use case but not a breaking API change
+
+      This isn't being released as major because the breaking change
+      is to an unsupported/undocumented use, but we still want to notify
+      people that might be using it that way.`,
+    },
+  ];
+  const releaseType = await analyzeCommits({}, { cwd, commits, logger: t.context.logger });
+
+  t.is(releaseType, "minor");
+});
+
 test('Accept "preset" option', async (t) => {
   const commits = [
     { hash: "123", message: "Fix: First fix (fixes #123)" },

There may not be a reasonable way to prevent this without breaking intended use, but when combined with semantic-release/semantic-release#3721 this led to quite the predicament.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions