chore: Allow the usage of the breaking-change trailer for changelog e…

…ntries
matrix-org · Oct 9, 2024 · c4a2ebc · c4a2ebc
1 parent c2efa95
commit c4a2ebc
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 1 deletion.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -40,7 +40,8 @@ olm, cipher).
 In addition to the Conventional Commit format, you can use the `Changelog` git
 trailer to specify the changelog message explicitly. When that trailer is
 present, its value will be used as the changelog entry instead of the commit's
-leading line.
+leading line. The `Breaking-Change` git trailer can be used in a similar manner
+if the changelog entry should be marked as a breaking change.
 
 
 #### Example Commit Message

diff --git a/cliff.toml b/cliff.toml
@@ -22,6 +22,8 @@ body = """
         {% for footer in commit.footers -%}
             {% if footer.token | lower  == "changelog" -%}
                 {% set_global commit_message = footer.value -%}
+            {% elif footer.token | lower  == "breaking-change" -%}
+                {% set_global commit_message = footer.value -%}
             {% elif footer.token | lower == "security-impact" -%}
                 {% set_global security_impact = footer.value -%}
             {% elif footer.token | lower == "cve" -%}