From ab9ade3d10acfa51cfde0e626323782ffa5a8808 Mon Sep 17 00:00:00 2001
From: Marco Ieni <11428655+MarcoIeni@users.noreply.github.com>
Date: Tue, 16 Apr 2024 22:59:16 +0200
Subject: [PATCH 1/7] feat: allow adding custom context

---
 git-cliff-core/src/changelog.rs | 36 +++++++++++++++++++++++++++------
 git-cliff-core/src/template.rs  |  4 ++--
 2 files changed, 32 insertions(+), 8 deletions(-)

diff --git a/git-cliff-core/src/changelog.rs b/git-cliff-core/src/changelog.rs
index 662c306683..9ce12a639c 100644
--- a/git-cliff-core/src/changelog.rs
+++ b/git-cliff-core/src/changelog.rs
@@ -28,10 +28,13 @@ use std::time::{
 #[derive(Debug)]
 pub struct Changelog<'a> {
 	/// Releases that the changelog will contain.
-	pub releases:    Vec<Release<'a>>,
-	body_template:   Template,
-	footer_template: Option<Template>,
-	config:          &'a Config,
+	pub releases:       Vec<Release<'a>>,
+	body_template:      Template,
+	footer_template:    Option<Template>,
+	config:             &'a Config,
+	/// Context to be injected into the tera template as key-value pairs.
+	/// The value is [`serde_json::Value`] because it needs to be serializable.
+	additional_context: HashMap<String, serde_json::Value>,
 }
 
 impl<'a> Changelog<'a> {
@@ -54,12 +57,30 @@ impl<'a> Changelog<'a> {
 				None => None,
 			},
 			config,
+			additional_context: HashMap::new(),
 		};
 		changelog.process_commits();
 		changelog.process_releases();
 		Ok(changelog)
 	}
 
+	/// Adds a key value pair to the template context.
+	///
+	/// These values will be used when generating the changelog.
+	///
+	/// # Errors
+	///
+	/// This operation fails if the deserialization fails.
+	pub fn add_context(
+		&mut self,
+		key: impl Into<String>,
+		value: impl serde::Serialize,
+	) -> Result<()> {
+		self.additional_context
+			.insert(key.into(), serde_json::to_value(value)?);
+		Ok(())
+	}
+
 	/// Processes a single commit and returns/logs the result.
 	fn process_commit(
 		commit: Commit<'a>,
@@ -232,8 +253,11 @@ impl<'a> Changelog<'a> {
 	/// Generates the changelog and writes it to the given output.
 	pub fn generate<W: Write>(&self, out: &mut W) -> Result<()> {
 		debug!("Generating changelog...");
-		let mut additional_context = HashMap::new();
-		additional_context.insert("remote", self.config.remote.clone());
+		let mut additional_context = self.additional_context.clone();
+		additional_context.insert(
+			"remote".to_string(),
+			serde_json::to_value(self.config.remote.clone())?,
+		);
 		#[cfg(feature = "github")]
 		let (github_commits, github_pull_requests) = self.get_github_metadata()?;
 		let postprocessors = self
diff --git a/git-cliff-core/src/template.rs b/git-cliff-core/src/template.rs
index d4542c8fa4..7caaf00fe8 100644
--- a/git-cliff-core/src/template.rs
+++ b/git-cliff-core/src/template.rs
@@ -143,7 +143,7 @@ impl Template {
 	}
 
 	/// Renders the template.
-	pub fn render<C: Serialize, T: Serialize, S: Into<String> + Copy>(
+	pub fn render<C: Serialize, T: Serialize, S: Into<String> + Clone>(
 		&self,
 		context: &C,
 		additional_context: Option<&HashMap<S, T>>,
@@ -152,7 +152,7 @@ impl Template {
 		let mut context = TeraContext::from_serialize(context)?;
 		if let Some(additional_context) = additional_context {
 			for (key, value) in additional_context {
-				context.insert(*key, &value);
+				context.insert(key.clone(), &value);
 			}
 		}
 		match self.tera.render("template", &context) {

From 49b3f3e399f9f237f39b6fa085230e799b21e88e Mon Sep 17 00:00:00 2001
From: Marco Ieni <11428655+MarcoIeni@users.noreply.github.com>
Date: Tue, 16 Apr 2024 23:23:01 +0200
Subject: [PATCH 2/7] chore: add test

---
 Cargo.lock                      | 17 +++++++
 git-cliff-core/Cargo.toml       |  1 +
 git-cliff-core/src/changelog.rs | 83 +++++++++++++++++++++++++++++++++
 3 files changed, 101 insertions(+)

diff --git a/Cargo.lock b/Cargo.lock
index 0df7bb0ebd..61545b25a7 100644
--- a/Cargo.lock
+++ b/Cargo.lock
@@ -507,6 +507,12 @@ dependencies = [
  "windows-sys 0.48.0",
 ]
 
+[[package]]
+name = "dissimilar"
+version = "1.0.7"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "86e3bdc80eee6e16b2b6b0f87fbc98c04bee3455e35174c0de1a125d0688c632"
+
 [[package]]
 name = "doc-comment"
 version = "0.3.3"
@@ -572,6 +578,16 @@ dependencies = [
  "windows-sys 0.52.0",
 ]
 
+[[package]]
+name = "expect-test"
+version = "1.5.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "9e0be0a561335815e06dab7c62e50353134c796e7a6155402a64bcff66b6a5e0"
+dependencies = [
+ "dissimilar",
+ "once_cell",
+]
+
 [[package]]
 name = "fastrand"
 version = "2.0.2"
@@ -747,6 +763,7 @@ dependencies = [
  "config",
  "dirs",
  "document-features",
+ "expect-test",
  "futures",
  "git-conventional",
  "git2",
diff --git a/git-cliff-core/Cargo.toml b/git-cliff-core/Cargo.toml
index 9bd5adc672..6f17fd9196 100644
--- a/git-cliff-core/Cargo.toml
+++ b/git-cliff-core/Cargo.toml
@@ -79,6 +79,7 @@ features = ["debug-embed", "compression"]
 
 [dev-dependencies]
 pretty_assertions = "1.4.0"
+expect-test = "1.5.0"
 
 [package.metadata.docs.rs]
 all-features = true
diff --git a/git-cliff-core/src/changelog.rs b/git-cliff-core/src/changelog.rs
index 9ce12a639c..3ff9806eb0 100644
--- a/git-cliff-core/src/changelog.rs
+++ b/git-cliff-core/src/changelog.rs
@@ -842,4 +842,87 @@ chore(deps): fix broken deps
 		);
 		Ok(())
 	}
+
+	#[test]
+	fn changelog_adds_additional_context() -> Result<()> {
+		let (mut config, releases) = get_test_data();
+		// add `{{ custom_field }}` to the template
+		config.changelog.body = Some(
+			r#"{% if version %}
+				## {{ custom_field }} [{{ version }}] - {{ timestamp | date(format="%Y-%m-%d") }}
+				{% if commit_id %}({{ commit_id }}){% endif %}{% else %}
+				## Unreleased{% endif %}
+				{% for group, commits in commits | group_by(attribute="group") %}
+				### {{ group }}{% for group, commits in commits | group_by(attribute="scope") %}
+				#### {{ group }}{% for commit in commits %}
+				- {{ commit.message }}{% endfor %}
+				{% endfor %}{% endfor %}"#
+				.to_string(),
+		);
+		let mut changelog = Changelog::new(releases, &config)?;
+		changelog.add_context("custom_field", "Hello").unwrap();
+		let mut out = Vec::new();
+		changelog.generate(&mut out)?;
+		expect_test::expect![[r#"
+    # Changelog
+    ## Unreleased
+
+    ### Bug Fixes
+    #### app
+    - fix abc
+
+    ### New features
+    #### app
+    - add xyz
+
+    ### Other
+    #### app
+    - document zyx
+
+    #### ui
+    - do exciting stuff
+
+    ## Hello [v1.0.0] - 1971-08-02
+    (0bc123)
+
+    ### Bug Fixes
+    #### ui
+    - fix more stuff
+
+    ### Documentation
+    #### documentation
+    - update docs
+    - add some documentation
+
+    ### I love tea
+    #### app
+    - damn right
+
+    ### Matched (group)
+    #### group
+    - support regex-replace for groups
+
+    ### New features
+    #### app
+    - add cool features
+
+    #### other
+    - support unscoped commits
+    - support breaking commits
+
+    ### Other
+    #### app
+    - do nothing
+
+    #### other
+    - support unconventional commits
+    - this commit is preprocessed
+
+    #### ui
+    - make good stuff
+    -- total releases: 2 --
+"#]]
+		.assert_eq(&str::from_utf8(&out).unwrap());
+		Ok(())
+	}
 }

From ca2106effcdfaff15da81b6ede0ddf5f4b5f7ad7 Mon Sep 17 00:00:00 2001
From: Marco Ieni <11428655+MarcoIeni@users.noreply.github.com>
Date: Tue, 16 Apr 2024 23:25:42 +0200
Subject: [PATCH 3/7] fix: lint

---
 git-cliff-core/src/changelog.rs | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/git-cliff-core/src/changelog.rs b/git-cliff-core/src/changelog.rs
index 3ff9806eb0..e5bfb6cfca 100644
--- a/git-cliff-core/src/changelog.rs
+++ b/git-cliff-core/src/changelog.rs
@@ -860,7 +860,7 @@ chore(deps): fix broken deps
 				.to_string(),
 		);
 		let mut changelog = Changelog::new(releases, &config)?;
-		changelog.add_context("custom_field", "Hello").unwrap();
+		changelog.add_context("custom_field", "Hello")?;
 		let mut out = Vec::new();
 		changelog.generate(&mut out)?;
 		expect_test::expect![[r#"

From aa28e01e463d20e47c801f4e42296a31b34567c0 Mon Sep 17 00:00:00 2001
From: Marco Ieni <11428655+MarcoIeni@users.noreply.github.com>
Date: Tue, 16 Apr 2024 23:26:20 +0200
Subject: [PATCH 4/7] fix: lint

---
 git-cliff-core/src/changelog.rs | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/git-cliff-core/src/changelog.rs b/git-cliff-core/src/changelog.rs
index e5bfb6cfca..757424a2ee 100644
--- a/git-cliff-core/src/changelog.rs
+++ b/git-cliff-core/src/changelog.rs
@@ -922,7 +922,7 @@ chore(deps): fix broken deps
     - make good stuff
     -- total releases: 2 --
 "#]]
-		.assert_eq(&str::from_utf8(&out).unwrap());
+		.assert_eq(&str::from_utf8(&out).unwrap_or_default());
 		Ok(())
 	}
 }

From 5b9cad894116c95057aa3d65b5b223f75514c801 Mon Sep 17 00:00:00 2001
From: Marco Ieni <11428655+MarcoIeni@users.noreply.github.com>
Date: Tue, 16 Apr 2024 23:36:21 +0200
Subject: [PATCH 5/7] fix: lint

---
 git-cliff-core/src/changelog.rs | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/git-cliff-core/src/changelog.rs b/git-cliff-core/src/changelog.rs
index 757424a2ee..2642bf4354 100644
--- a/git-cliff-core/src/changelog.rs
+++ b/git-cliff-core/src/changelog.rs
@@ -922,7 +922,7 @@ chore(deps): fix broken deps
     - make good stuff
     -- total releases: 2 --
 "#]]
-		.assert_eq(&str::from_utf8(&out).unwrap_or_default());
+		.assert_eq(str::from_utf8(&out).unwrap_or_default());
 		Ok(())
 	}
 }

From 33cec92cd5891164dafd54f4d10019987347c7d9 Mon Sep 17 00:00:00 2001
From: Marco Ieni <11428655+MarcoIeni@users.noreply.github.com>
Date: Sun, 21 Apr 2024 15:39:30 +0200
Subject: [PATCH 6/7] docs: contributing

---
 CONTRIBUTING.md | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index dc749ac6c5..ab7f4f85ce 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -31,7 +31,13 @@ cargo build
 cargo test
 ```
 
-6. Make sure [rustfmt](https://github.com/rust-lang/rustfmt) and [clippy](https://github.com/rust-lang/rust-clippy) don't complain about your changes.
+6. If needed, update the snapshot tests (i.e. tests using `expect_test`):
+
+```
+env UPDATE_EXPECT=1 cargo t
+```
+
+7. Make sure [rustfmt](https://github.com/rust-lang/rustfmt) and [clippy](https://github.com/rust-lang/rust-clippy) don't complain about your changes.
 
 We use the `nightly` channel for `rustfmt` so please set the appropriate settings for your editor/IDE for that.
 

From 2f6b1dfd9b0f6042fd242b59c51ed4b4c66e3d89 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Orhun=20Parmaks=C4=B1z?= <orhunparmaksiz@gmail.com>
Date: Sun, 21 Apr 2024 21:58:17 +0300
Subject: [PATCH 7/7] chore: polish implementation

---
 CONTRIBUTING.md                 | 4 ++--
 git-cliff-core/src/changelog.rs | 2 --
 2 files changed, 2 insertions(+), 4 deletions(-)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index ab7f4f85ce..9c8b650311 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -33,8 +33,8 @@ cargo test
 
 6. If needed, update the snapshot tests (i.e. tests using `expect_test`):
 
-```
-env UPDATE_EXPECT=1 cargo t
+```sh
+env UPDATE_EXPECT=1 cargo test
 ```
 
 7. Make sure [rustfmt](https://github.com/rust-lang/rustfmt) and [clippy](https://github.com/rust-lang/rust-clippy) don't complain about your changes.
diff --git a/git-cliff-core/src/changelog.rs b/git-cliff-core/src/changelog.rs
index 2642bf4354..8760eac6f8 100644
--- a/git-cliff-core/src/changelog.rs
+++ b/git-cliff-core/src/changelog.rs
@@ -32,8 +32,6 @@ pub struct Changelog<'a> {
 	body_template:      Template,
 	footer_template:    Option<Template>,
 	config:             &'a Config,
-	/// Context to be injected into the tera template as key-value pairs.
-	/// The value is [`serde_json::Value`] because it needs to be serializable.
 	additional_context: HashMap<String, serde_json::Value>,
 }