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

Add output file configuration option #827

Closed
1 task done
RJSonnenberg opened this issue Aug 29, 2024 · 2 comments · Fixed by #829
Closed
1 task done

Add output file configuration option #827

RJSonnenberg opened this issue Aug 29, 2024 · 2 comments · Fixed by #829
Assignees
Labels
feature/request New feature or request

Comments

@RJSonnenberg
Copy link

Is there an existing issue or pull request for this?

  • I have searched the existing issues and pull requests

Feature description

Where I work, it is the common case for us to want to generate and regenerate our CHANGELOG.md docs. Currently, to actually generate a document with git-cliff, we always have to pass it the --output CHANGELOG.md argument. This gets tedious to have to type out every time. It also means that, if we happen to typo the file name, we have to rename the file and delete the original (if regenerating).

Desired solution

Create an output-file option that would go under the [changelog] section in the cliff.toml file that behaves the same as the --output CLI argument.

Alternatives considered

I was not able to discern an alternative solution for this issue.

Additional context

No response

@RJSonnenberg RJSonnenberg added the feature/request New feature or request label Aug 29, 2024
Copy link

welcome bot commented Aug 29, 2024

Thanks for opening your first issue at git-cliff! Be sure to follow the issue template! ⛰️

@orhun
Copy link
Owner

orhun commented Aug 30, 2024

Hey!

It is not implemented in #829 - can you pull from that branch and test it out? 😊

Tip

If you are using CHANGELOG.md as default and do not want to give the file name every time, you can simply omit the file name since it is the default.

e.g.

$ git cliff -o

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

Successfully merging a pull request may close this issue.

2 participants