feat(git): support disabling sorting commits topologically (#804) (#1121)

* feat(git): disable sorting commits topologically (#804)

* Update config/cliff.toml

Co-authored-by: Orhun Parmaksız <orhunparmaksiz@gmail.com>

* Update website/docs/configuration/git.md

Co-authored-by: Orhun Parmaksız <orhunparmaksiz@gmail.com>

* Update .github/fixtures/test-topo-order-commits/cliff.toml

Co-authored-by: Orhun Parmaksız <orhunparmaksiz@gmail.com>

* Update website/docs/configuration/git.md

Co-authored-by: Orhun Parmaksız <orhunparmaksiz@gmail.com>

* Update website documentation

* Simplify configuration

---------

Co-authored-by: Orhun Parmaksız <orhunparmaksiz@gmail.com>

Author: SebClapie

.github/fixtures/test-topo-order-commits/cliff.toml

@@ -0,0 +1,7 @@
+# git-cliff ~ configuration file
+# https://git-cliff.org/docs/configuration
+
+
+[git]
+
+topo_order_commits = false

.github/fixtures/test-topo-order-commits/commit.sh

@@ -0,0 +1,16 @@
+#!/usr/bin/env bash
+set -e
+
+GIT_COMMITTER_DATE="2022-04-06 03:25:08" git commit --allow-empty -m "Initial commit"
+GIT_COMMITTER_DATE="2022-04-06 03:25:09" git commit --allow-empty -m "feat: add feature 1"
+GIT_COMMITTER_DATE="2022-04-06 03:25:10" git commit --allow-empty -m "fix: fix feature 1"
+git tag v0.1.0
+GIT_COMMITTER_DATE="2022-04-06 03:25:11" git commit --allow-empty -m "feat(gui): add feature 2"
+GIT_COMMITTER_DATE="2022-04-06 03:25:12" git commit --allow-empty -m "fix(gui): fix feature 2"
+git tag v0.2.0
+GIT_COMMITTER_DATE="2022-04-06 03:25:25" git commit --allow-empty -m "test: add tests"
+GIT_COMMITTER_DATE="2022-04-06 03:25:25" git checkout v0.1.0
+GIT_COMMITTER_DATE="2022-04-06 03:25:13" git commit --allow-empty -m "fix: fix again feature 1"
+git tag v0.1.1
+git checkout master
+git merge v0.1.1 --no-edit

.github/fixtures/test-topo-order-commits/expected.md

@@ -0,0 +1,37 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## [unreleased]
+
+### 🧪 Testing
+
+- Add tests
+
+## [0.1.1] - 2022-04-06
+
+### 🐛 Bug Fixes
+
+- Fix again feature 1
+
+## [0.2.0] - 2022-04-06
+
+### 🚀 Features
+
+- *(gui)* Add feature 2
+
+### 🐛 Bug Fixes
+
+- *(gui)* Fix feature 2
+
+## [0.1.0] - 2022-04-06
+
+### 🚀 Features
+
+- Add feature 1
+
+### 🐛 Bug Fixes
+
+- Fix feature 1
+
+<!-- generated by git-cliff -->

.github/workflows/test-fixtures.yml

@@ -110,6 +110,7 @@ jobs:
           - fixtures-name: test-require-conventional-skipped
           - fixtures-name: test-remote-config
             command: --config-url "https://github.com/orhun/git-cliff/blob/main/.github/fixtures/new-fixture-template/cliff.toml?raw=true"
+          - fixtures-name: test-topo-order-commits
 
     steps:
       - name: Checkout

config/cliff.toml

@@ -94,6 +94,8 @@ link_parsers = []
 use_branch_tags = false
 # Order releases topologically instead of chronologically.
 topo_order = false
+# Order releases topologically instead of chronologically.
+topo_order_commits = true
 # Order of commits in each group/release within the changelog.
 # Allowed values: newest, oldest
 sort_commits = "oldest"

git-cliff-core/src/changelog.rs

@@ -862,6 +862,7 @@ mod test {
 				count_tags:               None,
 				use_branch_tags:          false,
 				topo_order:               false,
+				topo_order_commits:       true,
 				sort_commits:             String::from("oldest"),
 				link_parsers:             [].to_vec(),
 				limit_commits:            None,

git-cliff-core/src/config.rs

@@ -130,6 +130,8 @@ pub struct GitConfig {
 	pub use_branch_tags:          bool,
 	/// Order releases topologically instead of chronologically.
 	pub topo_order:               bool,
+	/// Order commits chronologically instead of topologically.
+	pub topo_order_commits:       bool,
 	/// How to order commits in each group/release within the changelog.
 	pub sort_commits:             String,
 	/// Limit the total number of commits included in the changelog.

git-cliff-core/src/repo.rs

@@ -118,9 +118,15 @@ impl Repository {
 		range: Option<&str>,
 		include_path: Option<Vec<Pattern>>,
 		exclude_path: Option<Vec<Pattern>>,
+		topo_order_commits: bool,
 	) -> Result<Vec<Commit>> {
 		let mut revwalk = self.inner.revwalk()?;
-		revwalk.set_sorting(Sort::TOPOLOGICAL)?;
+		if topo_order_commits {
+			revwalk.set_sorting(Sort::TOPOLOGICAL)?;
+		} else {
+			revwalk.set_sorting(Sort::TIME)?;
+		}
+
 		Self::set_commit_range(&mut revwalk, range).map_err(|e| {
 			Error::SetCommitRangeError(
 				range.map(String::from).unwrap_or_else(|| "?".to_string()),
@@ -621,7 +627,7 @@ mod test {
 	#[test]
 	fn get_latest_commit() -> Result<()> {
 		let repository = get_repository()?;
-		let commits = repository.commits(None, None, None)?;
+		let commits = repository.commits(None, None, None, false)?;
 		let last_commit =
 			AppCommit::from(&commits.first().expect("no commits found").clone());
 		assert_eq!(get_last_commit_hash()?, last_commit.id);
@@ -739,7 +745,7 @@ mod test {
 		let repository = get_repository()?;
 		// a close descendant of the root commit
 		let range = Some("eea3914c7ab07472841aa85c36d11bdb2589a234");
-		let commits = repository.commits(range, None, None)?;
+		let commits = repository.commits(range, None, None, false)?;
 		let root_commit =
 			AppCommit::from(&commits.last().expect("no commits found").clone());
 		assert_eq!(get_root_commit_hash()?, root_commit.id);

git-cliff-core/tests/integration_test.rs

@@ -124,6 +124,7 @@ fn generate_changelog() -> Result<()> {
 		count_tags:               None,
 		use_branch_tags:          false,
 		topo_order:               false,
+		topo_order_commits:       true,
 		sort_commits:             String::from("oldest"),
 		link_parsers:             vec![
 			LinkParser {

git-cliff/src/lib.rs

@@ -173,7 +173,12 @@ fn process_repository<'a>(
 		}
 	} else if args.latest || args.current {
 		if tags.len() < 2 {
-			let commits = repository.commits(None, None, None)?;
+			let commits = repository.commits(
+				None,
+				None,
+				None,
+				config.git.topo_order_commits,
+			)?;
 			if let (Some(tag1), Some(tag2)) = (
 				commits.last().map(|c| c.id().to_string()),
 				tags.get_index(0).map(|(k, _)| k),
@@ -241,6 +246,7 @@ fn process_repository<'a>(
 		commit_range.as_deref(),
 		include_path,
 		args.exclude_path.clone(),
+		config.git.topo_order_commits,
 	)?;
 	if let Some(commit_limit_value) = config.git.limit_commits {
 		commits.truncate(commit_limit_value);