Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Global configuration file and builtin configuration #2

Closed
toyboot4e opened this issue Aug 13, 2021 · 1 comment
Closed

Global configuration file and builtin configuration #2

toyboot4e opened this issue Aug 13, 2021 · 1 comment
Assignees
Labels
feature/request New feature or request

Comments

@toyboot4e
Copy link

Hi, git-cliff is cool stuff!

1. Is your feature request related to a problem? Please describe.
I'd like to not put cliff.toml in my repository when I use git-cliff just as an alternative to git log.

2. Describe the solution you'd like
git-cliff locates cliff.toml in ~/.config/git-cliff/cliff.toml. If no configuraiton file is found, git-cliff uses default (builtin) configuration.

3. Describe alternatives you've considered
git-cliff looks into GIT_CLIF_CONFIG environment variable.

4. Additional context
Default configuration removes the need of copying cliff.toml, so it would help first-time users.

@orhun
Copy link
Owner

orhun commented Aug 18, 2021

With the v0.2.* release:

  • default configuration file is embedded into the binary and it is used if no configuration file is specified
  • this embedded configuration file can be saved to cliff.toml via git cliff --init
  • configuration file is read from $HOME/.config/git-cliff/cliff.toml if the path exists

Closing, thank you for submitting this issue!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature/request New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants