feat(config): support configuring with a remote URL (#1083)

orhun · web-flow · commit eb9b6bdff712 · 2025-03-23T13:33:36.000+03:00
diff --git a/.github/fixtures/test-remote-config/cliff.toml b/.github/fixtures/test-remote-config/cliff.toml
@@ -0,0 +1,2 @@
+[changelog]
+header = "This is going to be overriden"
diff --git a/.github/fixtures/test-remote-config/commit.sh b/.github/fixtures/test-remote-config/commit.sh
@@ -0,0 +1,11 @@
+#!/usr/bin/env bash
+set -e
+
+GIT_COMMITTER_DATE="2022-04-06 01:25:08" git commit --allow-empty -m "Initial commit"
+GIT_COMMITTER_DATE="2022-04-06 01:25:09" git commit --allow-empty -m "feat: add feature 1"
+GIT_COMMITTER_DATE="2022-04-06 01:25:10" git commit --allow-empty -m "fix: fix feature 1"
+git tag v0.1.0
+GIT_COMMITTER_DATE="2022-04-06 01:25:11" git commit --allow-empty -m "feat(gui): add feature 2"
+GIT_COMMITTER_DATE="2022-04-06 01:25:12" git commit --allow-empty -m "fix(gui): fix feature 2"
+git tag v0.2.0
+GIT_COMMITTER_DATE="2022-04-06 01:25:13" git commit --allow-empty -m "test: add tests"
diff --git a/.github/fixtures/test-remote-config/expected.md b/.github/fixtures/test-remote-config/expected.md
@@ -0,0 +1,31 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## [unreleased]
+
+### Test
+
+- Add tests
+
+## [0.2.0] - 2022-04-06
+
+### Bug Fixes
+
+- Fix feature 2
+
+### Features
+
+- Add feature 2
+
+## [0.1.0] - 2022-04-06
+
+### Bug Fixes
+
+- Fix feature 1
+
+### Features
+
+- Add feature 1
+
+<!-- generated by git-cliff -->
diff --git a/.github/workflows/test-fixtures.yml b/.github/workflows/test-fixtures.yml
@@ -108,6 +108,8 @@ jobs:
             command: v2.6.1..v2.7.0 --include-path .github/fixtures/
           - fixtures-name: test-require-conventional-negative
           - 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"
 
     steps:
       - name: Checkout
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -10,6 +10,13 @@ secrecy = { version = "0.8.0", features = ["serde"] }
 lazy_static = "1.5.0"
 dirs = "5.0.1"
 url = "2.5.3"
+reqwest = { version = "0.12.12", default-features = false, features = [
+  "blocking",
+  "rustls-tls",
+  "rustls-tls-native-roots",
+  "json",
+  "zstd",
+] }
 
 [profile.dev]
 opt-level = 0
diff --git a/git-cliff-core/Cargo.toml b/git-cliff-core/Cargo.toml
@@ -61,12 +61,7 @@ lazy-regex = "3.4.1"
 next_version = "0.2.21"
 semver = "1.0.25"
 document-features = { version = "0.2.10", optional = true }
-reqwest = { version = "0.12.12", default-features = false, features = [
-  "rustls-tls",
-  "rustls-tls-native-roots",
-  "json",
-  "zstd",
-], optional = true }
+reqwest = { workspace = true, optional = true }
 http-cache-reqwest = { version = "0.15.0", optional = true }
 reqwest-middleware = { version = "0.4.0", optional = true }
 tokio = { version = "1.43.0", features = [
diff --git a/git-cliff/Cargo.toml b/git-cliff/Cargo.toml
@@ -27,7 +27,7 @@ default = ["update-informer", "github", "gitlab", "gitea", "bitbucket"]
 # inform about new releases
 update-informer = ["dep:update-informer"]
 # enable remote repository integration
-remote = ["dep:indicatif"]
+remote = ["dep:indicatif", "dep:reqwest"]
 # enable GitHub integration
 github = ["remote", "git-cliff-core/github"]
 # enable GitLab integration
@@ -56,6 +56,7 @@ indicatif = { version = "0.17.9", optional = true }
 env_logger = "=0.10.2"
 pprof = { version = "0.14", optional = true }
 rand = { version = "0.8.4", optional = true }
+reqwest = { workspace = true, optional = true }
 url.workspace = true
 pathdiff = "0.2.3"
 
diff --git a/git-cliff/src/args.rs b/git-cliff/src/args.rs
@@ -110,6 +110,9 @@ pub struct Opt {
 	    value_parser = Opt::parse_dir
 	)]
 	pub config:           PathBuf,
+	/// Sets the URL for the configuration file.
+	#[arg(long, env = "GIT_CLIFF_CONFIG_URL", value_name = "URL", hide = !cfg!(feature = "remote"))]
+	pub config_url:       Option<Url>,
 	/// Sets the working directory.
 	#[arg(
 	    short,
diff --git a/git-cliff/src/lib.rs b/git-cliff/src/lib.rs
@@ -478,7 +478,20 @@ pub fn run_with_changelog_modifier(
 
 	// Parse the configuration file.
 	// Load the default configuration if necessary.
-	let mut config = if let Ok((config, name)) = builtin_config {
+	let mut config = if let Some(url) = &args.config_url {
+		debug!("Using configuration file from: {url}");
+		#[cfg(feature = "remote")]
+		{
+			let contents = reqwest::blocking::get(url.clone())?
+				.error_for_status()?
+				.text()?;
+			Config::parse_from_str(&contents)?
+		}
+		#[cfg(not(feature = "remote"))]
+		unreachable!(
+			"This option is not available without the 'remote' build-time feature"
+		);
+	} else if let Ok((config, name)) = builtin_config {
 		info!("Using built-in configuration file: {name}");
 		config
 	} else if path.exists() {
diff --git a/website/docs/usage/args.md b/website/docs/usage/args.md
@@ -31,6 +31,7 @@ git-cliff [FLAGS] [OPTIONS] [--] [RANGE]
 -i, --init [<CONFIG>]              Writes the default configuration file to cliff.toml
     --bump                         Bumps the version for unreleased changes [default: auto] [possible values: auto, major, minor, patch]
 -c, --config <PATH>                Sets the configuration file [env: GIT_CLIFF_CONFIG=] [default: cliff.toml]
+    --config-url <URL>             Sets the URL for the configuration file [env: GIT_CLIFF_CONFIG_URL=]
 -w, --workdir <PATH>               Sets the working directory [env: GIT_CLIFF_WORKDIR=]
 -r, --repository <PATH>...         Sets the git repository [env: GIT_CLIFF_REPOSITORY=]
     --include-path <PATTERN>...    Sets the path to include related commits [env: GIT_CLIFF_INCLUDE_PATH=]
diff --git a/website/docs/usage/initializing.md b/website/docs/usage/initializing.md
@@ -41,3 +41,13 @@ Here are the list of available templates:
 - [`scopesorted.toml`](https://github.com/orhun/git-cliff/tree/main/examples/scopesorted.toml): changelog with commits grouped by their scopes and sorted by group.
 - [`cocogitto.toml`](https://github.com/orhun/git-cliff/tree/main/examples/cocogitto.toml): changelog similar to [cocogitto's format](https://github.com/cocogitto/cocogitto/blob/main/CHANGELOG.md).
 - [`unconventional.toml`](https://github.com/orhun/git-cliff/tree/main/examples/unconventional.toml): changelog for unconventional commits.
+
+:::tip
+
+It is also possible to use a remote URL for the configuration file as follows:
+
+```bash
+git cliff --config-url https://github.com/orhun/git-cliff/blob/main/examples/github-keepachangelog.toml?raw=true
+```
+
+:::

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+[changelog]`
	`2`	`+header = "This is going to be overriden"`