fix(submodules): fix submodules handling when using custom range (#1136)

lehmanju · orhun · web-flow · commit 451a694ad4d9 · 2025-04-26T18:40:37.000+03:00
* fix: first release wrong for submodules with custom range

* refactor: Update git-cliff/src/lib.rs

---------

Co-authored-by: Orhun Parmaksız &lt;orhunparmaksiz@gmail.com&gt;
diff --git a/.github/fixtures/test-submodules-include-path/expected.md b/.github/fixtures/test-submodules-include-path/expected.md
@@ -22,18 +22,6 @@ All notable changes to this project will be documented in this file.
 - Submodule_two with initial commits
 - Submodule_two update 1
 
-### Submodule_one
-
-#### Bug Fixes
-
-- Submodule_one fix A
-
-#### Features
-
-- Submodule_one feature A
-- Submodule_one initial commit
-
-
 ### Submodule_two
 
 #### Bug Fixes
diff --git a/.github/fixtures/test-submodules-range/cliff.toml b/.github/fixtures/test-submodules-range/cliff.toml
@@ -0,0 +1,38 @@
+# git-cliff ~ configuration file
+# https://git-cliff.org/docs/configuration
+
+[changelog]
+# A Tera template to be rendered for each release in the changelog.
+# See https://keats.github.io/tera/docs/#introduction
+body = """
+{% if version %}\
+    ## [{{ version | trim_start_matches(pat="v") }}] - {{ timestamp | date(format="%Y-%m-%d") }}
+{% else %}\
+    ## [unreleased]
+{% endif %}\
+{% for group, commits in commits | group_by(attribute="group") %}
+    ### {{ group | upper_first }}
+    {% for commit in commits %}
+        - {{ commit.message | upper_first }}\
+    {% endfor %}
+{% endfor %}\
+{% for submodule_path, commits in submodule_commits %}
+    ### {{ submodule_path | upper_first }}
+    {% for group, commits in commits | group_by(attribute="group") %}
+        #### {{ group | upper_first }}
+        {% for commit in commits %}
+            - {{ commit.message | upper_first }}\
+        {% endfor %}
+    {% endfor %}
+{% endfor %}\n
+"""
+
+[git]
+# An array of regex based parsers for extracting data from the commit message.
+# Assigns commits to groups.
+# Optionally sets the commit's `scope` and can decide to exclude commits from further processing.
+commit_parsers = [
+    { message = "^feat", group = "Features", default_scope = "app" },
+    { message = "^fix", group = "Bug Fixes", scope = "cli" },
+]
+recurse_submodules = true
diff --git a/.github/fixtures/test-submodules-range/commit.sh b/.github/fixtures/test-submodules-range/commit.sh
@@ -0,0 +1,42 @@
+#!/usr/bin/env bash
+set -e
+
+current_dir="$(pwd)"
+submodule_one_dir="$(mktemp -d)"
+submodule_two_dir="$(mktemp -d)"
+
+cd $submodule_one_dir && git init >&2
+GIT_COMMITTER_DATE="2022-04-05 01:00:8" git commit --allow-empty -m "feat: submodule_one initial commit"
+
+cd $submodule_two_dir && git init >&2
+GIT_COMMITTER_DATE="2022-04-05 01:00:12" git commit --allow-empty -m "feat: submodule_two feature B"
+
+cd $current_dir
+GIT_COMMITTER_DATE="2022-04-06 01:25:08" git commit --allow-empty -m "Initial commit"
+
+git -c protocol.file.allow=always submodule add $submodule_one_dir submodule_one
+GIT_COMMITTER_DATE="2022-04-06 01:25:09" git commit -a -m "feat: add submodule_one"
+
+cd submodule_one
+GIT_COMMITTER_DATE="2022-04-05 01:00:10" git commit --allow-empty -m "feat: submodule_one feature A"
+GIT_COMMITTER_DATE="2022-04-05 01:00:11" git commit --allow-empty -m "fix: submodule_one fix A"
+cd ..
+
+GIT_COMMITTER_DATE="2022-04-06 01:25:10" git commit -a -m "feat: submodule_one update 1"
+git tag v0.1.0
+
+git -c protocol.file.allow=always submodule add $submodule_two_dir submodule_two
+GIT_COMMITTER_DATE="2022-04-06 01:25:11" git commit -a -m "feat: submodule_two with initial commits"
+
+cd submodule_two
+GIT_COMMITTER_DATE="2022-04-05 01:00:13" git commit --allow-empty -m "fix: submodule_two fix B"
+cd ..
+
+GIT_COMMITTER_DATE="2022-04-06 01:25:12" git commit -a -m "feat: submodule_two update 1"
+git tag v0.2.0
+
+cd submodule_two
+GIT_COMMITTER_DATE="2022-04-05 01:00:14" git commit --allow-empty -m "fix: submodule_two fix C"
+cd ..
+
+GIT_COMMITTER_DATE="2022-04-06 01:25:13" git commit -a -m "feat: submodule_two update 2"
diff --git a/.github/fixtures/test-submodules-range/expected.md b/.github/fixtures/test-submodules-range/expected.md
@@ -0,0 +1,36 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## [unreleased]
+
+### Features
+
+- Submodule_two update 2
+
+### Submodule_two
+
+#### Bug Fixes
+
+- Submodule_two fix C
+
+
+## [0.2.0] - 2022-04-06
+
+### Features
+
+- Submodule_two with initial commits
+- Submodule_two update 1
+
+### Submodule_two
+
+#### Bug Fixes
+
+- Submodule_two fix B
+
+#### Features
+
+- Submodule_two feature B
+
+
+<!-- generated by git-cliff -->
diff --git a/.github/workflows/test-fixtures.yml b/.github/workflows/test-fixtures.yml
@@ -117,6 +117,8 @@ jobs:
           - fixtures-name: test-require-conventional-negative
           - fixtures-name: test-require-conventional-skipped
           - fixtures-name: test-submodules
+          - fixtures-name: test-submodules-range
+            command: v0.1.0..HEAD
           - fixtures-name: test-submodules-include-path
             command: --include-path submodule_two
           - fixtures-name: test-remote-config
diff --git a/git-cliff/src/lib.rs b/git-cliff/src/lib.rs
@@ -172,6 +172,8 @@ fn process_submodules(
 		.clone()
 		.and_then(|commit_id| repository.find_commit(&commit_id));
 
+	trace!("Processing submodule commits in {first_commit:?}..{last_commit:?}");
+
 	// Query repository for submodule changes. For each submodule a
 	// SubmoduleRange is created, describing the range of commits in the context
 	// of that submodule.
@@ -388,12 +390,6 @@ fn process_repository<'a>(
 		releases.last_mut().unwrap().previous = Some(Box::new(previous_release));
 	}
 
-	if recurse_submodules {
-		for release in &mut releases {
-			process_submodules(repository, release, config.git.topo_order_commits)?;
-		}
-	}
-
 	if args.sort == Sort::Newest {
 		for release in &mut releases {
 			release.commits.reverse();
@@ -443,6 +439,12 @@ fn process_repository<'a>(
 		}
 	}
 
+	if recurse_submodules {
+		for release in &mut releases {
+			process_submodules(repository, release, config.git.topo_order_commits)?;
+		}
+	}
+
 	// Set custom message for the latest release.
 	if let Some(message) = &args.with_tag_message {
 		if let Some(latest_release) = releases
