From 8fb1bc776afd47ef4bc989e95f83fbfc604e8bc2 Mon Sep 17 00:00:00 2001
From: Mike Bender <mikebender@deephaven.io>
Date: Fri, 23 Aug 2024 09:42:03 -0400
Subject: [PATCH] chore: Add template for grouping BREAKING CHANGES to the top
 (#5964)

- Also added a cog.toml file
- Just run `cog changelog` to generate the full changelog
- For between two tags/commits, add the range as an arg, e.g. `cog
changelog v0.35.0..v0.36.0`
- Generates a changelog file with the text from the Breaking Changes
footers at the top
---
 cog.toml            |  6 ++++++
 deephaven-changelog | 51 +++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 57 insertions(+)
 create mode 100644 cog.toml
 create mode 100644 deephaven-changelog

diff --git a/cog.toml b/cog.toml
new file mode 100644
index 00000000000..bf4a185fe6c
--- /dev/null
+++ b/cog.toml
@@ -0,0 +1,6 @@
+[changelog]
+path = "CHANGELOG.md"
+template = "deephaven-changelog"
+remote = "github.com"
+repository = "deephaven-core"
+owner = "deephaven"
\ No newline at end of file
diff --git a/deephaven-changelog b/deephaven-changelog
new file mode 100644
index 00000000000..2b1048e34d5
--- /dev/null
+++ b/deephaven-changelog
@@ -0,0 +1,51 @@
+{# Tera templates are used to generate the changelog content -#}
+{# https://keats.github.io/tera/docs/ -#}
+{# Based on Cocogittos remote template, but adds breaking changes: https://github.com/cocogitto/cocogitto/blob/main/src/conventional/changelog/template/remote -#}
+{# First display all the breaking changes -#}
+{% set breaking_commits = commits | filter(attribute="breaking_change", value=true) -%}
+{% if breaking_commits | length > 0 -%}
+#### ⚠ Breaking Changes
+
+{% for commit in breaking_commits -%}
+{% set commit_link = repository_url ~ "/commit/" ~ commit.id -%}
+{% set shorthand = commit.id | truncate(length=7, end="") -%}
+{% for footer in commit.footer | filter(attribute="token", value="BREAKING CHANGE") -%}
+- {{ footer.content }} - ([{{shorthand}}]({{ commit_link }}))
+{% endfor -%}
+{% endfor -%}
+{% endif %}
+
+{# Now group the rest of the commits and display them -#}
+{% for type, typed_commits in commits | sort(attribute="type")| group_by(attribute="type") -%}
+#### {{ type | upper_first }}
+{% for scope, scoped_commits in typed_commits | group_by(attribute="scope") -%}
+
+{% for commit in scoped_commits | sort(attribute="scope") -%}
+    {% if commit.author and repository_url -%}
+        {% set author = "@" ~ commit.author -%}
+        {% set author_link = platform ~ "/" ~ commit.author -%}
+        {% set author = "[" ~ author ~ "](" ~ author_link ~ ")" -%}
+    {% else -%}
+        {% set author = commit.signature -%}
+    {% endif -%}
+    {% set commit_link = repository_url ~ "/commit/" ~ commit.id -%}
+    {% set shorthand = commit.id | truncate(length=7, end="") -%}
+    - **({{ scope }})** {{ commit.summary }} - ([{{shorthand}}]({{ commit_link }})) - {{ author }}
+{% endfor -%}
+
+{% endfor -%}
+
+{% for commit in typed_commits | unscoped -%}
+    {% if commit.author and repository_url -%}
+        {% set author = "@" ~ commit.author -%}
+        {% set author_link = platform ~ "/" ~ commit.author -%}
+        {% set author = "[" ~ author ~ "](" ~ author_link ~ ")" -%}
+    {% else -%}
+        {% set author = commit.signature -%}
+    {% endif -%}
+    {% set commit_link = repository_url ~ "/commit/" ~ commit.id -%}
+    {% set shorthand = commit.id | truncate(length=7, end="") -%}
+    - {{ commit.summary }} - ([{{shorthand}}]({{ commit_link }})) - {{ author }}
+{% endfor -%}
+
+{% endfor -%}
\ No newline at end of file