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 commit hash and issue number to the changelog format as optional variables #1229

Open
nongrata081 opened this issue Sep 7, 2024 · 2 comments

Comments

@nongrata081
Copy link

nongrata081 commented Sep 7, 2024

Description

It would be nice to get for each commit in the generated changelog as as optional variables:

See an example that was generated with conventional-changelog-cli (node.js). See npm script that generates the changelog.

The justification is that having short commit hash and issue number as clickable links in repo gives a possibility to quickly access the related code and issues/threads in github, thus having full context of the item / entity worked on, without having to search for it by hand, that would take much more time.

changelog-example

Possible Solution

add linked commit hash and issue number as optional variables to each commit to changelog format

Additional context

No response

Additional context

No response

@kmnhan
Copy link
Contributor

kmnhan commented Oct 8, 2024

As a workaround, I built a plugin that tries to do what is mentioned. It will be great to have this implemented natively!

@woile
Copy link
Member

woile commented Oct 8, 2024

Wanna add it to the third party section in the docs?
https://commitizen-tools.github.io/commitizen/third-party-commitizen/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants