The global configuration file has the highest priority

[hituzi-no-sippo]

Thank you for creating a great tool.
I'm sorry if the behavior this is a specification.

Describe the bug

The global configuration file has the highest priority.
Is this the expected behavior?
Load the global configuration file even if cliff.toml is in the current directory.

To Reproduce

1. Create git repository.
2. Create git-cliff three configuration files.
   • local (cliff.toml)
   • global (~/.config/git-cliff/cliff.toml)
   • The file specified by --config (config.toml)
3. run git cliff
   Load global configuration file.
4. run git cliff --config config.toml
   Load global configuration file.

Expected behavior

This is an environment with a global configuration file.

• git cliff
  • cliff.toml exists in the current directory:: Load cliff.toml in the current directory.
  • cliff.toml does not exists in the current directory:: Load global configuration.
• git cliff --config <PATH>
  • <PATH> exists:: Load <PATH>.
  • <PATH> does not exist:: Load embedded default configuration file into the binary.

Screenshots/Logs

Check the file exists & Check diff

$ ls
cliff.toml  config.toml
$ diff cliff.toml config.toml
6c6
< # local config
---
> # config option
27c27
< <!-- local config -->
---
> <!-- config option -->
$ diff cliff.toml ~/.config/git-cliff/cliff.toml
6c6
< # local config
---
> # global config
27c27
< <!-- local config -->
---
> <!-- global config -->

A global configuration file exists

$ git cliff
# global config
## [unreleased]

### Miscellaneous Tasks

- Add git-cliff toml

<!-- global config -->

$ git cliff --config config.toml
# global config
## [unreleased]

### Miscellaneous Tasks

- Add git-cliff toml

<!-- global config -->

A global configuration file does not exist

$ rm ~/.config/git-cliff/cliff.toml
$ git cliff
# local config
## [unreleased]

### Miscellaneous Tasks

- Add git-cliff toml

<!-- local config -->

$ git cliff --config config.toml
# config option
## [unreleased]

### Miscellaneous Tasks

- Add git-cliff toml

<!-- config option -->

System (please complete the following information):

• OS Ubuntu 20.04 LTS (WSL2)
• Project Version: 2be04f8b2214513d08d349b254a97a8c783073fb

Additional context

Current Behavior

This is an environment with a global configuration file.

• git cliff
  • cliff.toml exists in the current directory:: Load global configuration file.
  • cliff.toml does not exists in the current directory:: Load global configuration file.
• git cliff --config <PATH>
  • <PATH> exists:: Load global configuration file.
  • <PATH> does not exist:: Load global configuration file.

References

• Global configuration file and builtin configuration · Issue #2 · orhun/git-cliff
• lib.rs

Thank you.

[orhun]

Hey, good catch! ⚾

This should be fixed in 2595952, can you try it out?

[hituzi-no-sippo]

Good job 👍

I've checked, it worked as expected.
Thank you 😄