Skip to content

Allow reading configuration file from .cliff.toml or .config/cliff.toml #1446

@danielpza

Description

@danielpza

Is there an existing issue or pull request for this?

  • I have searched the existing issues and pull requests

Feature description

It would be nice to allow reading the configuration file from .cliff.toml as well. It's a common pattern to make configuration files start with a dot .. This allows grouping/hiding all configuration files in a single place.

Desired solution

Using mise as example, it allows setting its configuration in several places:

mise.toml is the config file for mise. They can be at any of the following file paths (in order of precedence, top overrides configuration of lower paths):

  • mise.local.toml - used for local config, this should not be committed to source control
  • mise.toml
  • mise/config.toml
  • .mise/config.toml
  • .config/mise.toml - use this in order to group config files into a common directory
  • .config/mise/config.toml
  • .config/mise/conf.d/*.toml - all files in this directory will be loaded in alphabetical order

For git cliff:

  • cliff.toml
  • .cliff.toml
  • .config/cliff.toml
  • ...

Alternatives considered

GIT_CLIFF_CONFIG env variable.

Using an environment variable might be an alternative, although this makes it less portable and depends on individual users configuration

Additional context

No response

Metadata

Metadata

Assignees

Labels

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions