-
-
Notifications
You must be signed in to change notification settings - Fork 203
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
Enable having a footer like the KeepAChangelog one #95
Comments
I have tried adding this in
I do not really care about all the links being at the end of file, if they get into the end of section it is fine too. But unfortunately it does not work when I want to generate a changelog for a version not released yet. If I run
I expected |
Fixed this bug in 6203f77 |
Great, thanks! |
This will be supported when #369 is merged. |
* feat(changelog)!: support templating in the footer (#95) * test(fixture): run test-footer-template fixture
Is your feature request related to a problem? Please describe.
In my changelogs, I would like to have a footer like the one of KeepAChangelog:
This enables you to click on the links of each entry of the changelog to see the changes.
I think this isn't possible to achieve at the moment with
git-cliff
.Have you ever thought about supporting such a use case?
Describe the solution you'd like
There should be a way for git-cliff to update the footer of the changelog together with the body.
Describe alternatives you've considered
git-cliff could have a new entry in the configuration:
version_link
, in which the user can specify a template to add after the[<version>]:
row.For example, in the configuration you can have something like:
Then, git-cliff takes care of updating the versions at the end of the changelog.
Maybe you could also have a
unreleased_link
, because the template in this case is different:Additional context
Enabling "templated footers" isn't enough because every time you add a new entry to the changelog, you need to edit the
[Unreleased]
row with the latest version.For example, the footer for the 0.3.0 version looks like this:
Instead the footer of the 1.0.0 version looks like this:
As you can see we have both added the
[1.0.0]
row, and edited the[Unreleased]
one.The text was updated successfully, but these errors were encountered: