commitizen icon indicating copy to clipboard operation
commitizen copied to clipboard

[question] Pull request links and contributors in changelog?

Open feliblo opened this issue 4 weeks ago • 3 comments

Type

  • [ ] Content inaccurate
  • [x] Content missing
  • [ ] Typo

URL

https://commitizen-tools.github.io/commitizen/commands/changelog/

Description

Is there a way in the changelog generation to add the PR url's for commits and the contributors?

If that is the case I'd think this is very common to want to add and can it be a preset/better documented?

I couldn't find anything in the docs on that page (or any other page) when running searches on:

  • changelog pr
  • changelog pull request
  • changelog contributors

e.g. git-cliff shows great examples, but I prefer to use cz for bumping and the changelog https://git-cliff.org/docs/templating/examples

I'd be looking for something like the cogitto example

I found this, but it doesn't give any templates: https://commitizen-tools.github.io/commitizen/customization/#customizing-the-changelog-template

feliblo avatar Dec 09 '25 14:12 feliblo

IIRC there is no such feature in commitizen currently.

bearomorphism avatar Dec 10 '25 01:12 bearomorphism

I think we can customize the template to support it, but this should not be part of the core commitizen.

Lee-W avatar Dec 11 '25 02:12 Lee-W

but we could indeed add such template as an example or separate package

Lee-W avatar Dec 11 '25 02:12 Lee-W

I actually did put something together here: https://github.com/feliblo/dbtective/blob/main/CHANGELOG.md.j2

Ends up quite great in the changelog, but doesn't get picked up in my release notes (not sure if thats due to cargo dist). Without a template it works in release notes aswell. However a --template or similar could be more user friendly.

feliblo avatar Dec 12 '25 22:12 feliblo