Is there any config/template example for adding fixed/related/etc. github issues to changelog

[powerman]

Such issues are most often mentioned in PR description by using keywords in issues and pull requests. Then they may become a commit body (e.g. using PR squash merge).

git-cliff provides a way to get similar info from a commit footer, but with GitHub PRs this info won't be in a footer in most cases. So, looks like some parsing of commit body is needed, and implementing that in config templates may be tricky.

Is there any examples how to handle this, taking in account GitHub keywords and supported ways to merge PRs?

[orhun]

Just to be sure, do you want to parse the commit.body and group them accordingly? e.g. if a PR is closing an issue group it as fixes etc. If so, you can define your own commit_parser.

Can you maybe give me an example how your commits look like and the expected changelog?

[powerman]

No, I didn't mean to use this for grouping. I just want to mention closed/related/etc. issues in changelog.

Right now it's easy and usual to see a link to PR or commit related to changelog item, but that PR/commit in turn might be related to some issue(s) and I like to see links to these issues in same changelog item near link to PR/commit - this will save users from extra indirection level and opening intermediate links before they'll find out is some interesting issue was covered (closed) by some changelog line.

[orhun]

I just want to mention closed/related/etc. issues in changelog.

Got it. I think this is not supported as a part the template as of now. It can be achieved with using extra template variables etc. but yeah, it is painful.

Do you have any ideas how this would look like if it was implemented? Maybe something like commit.remote.closes etc.?

[powerman]

Yeah, list of closes issues would be great to have!
I suppose parsing logic will be different per provider (github, gitlab, etc.) and match how it works on the provider.
The end-goal is show in changelog same info about related (closed) issues as user will see after opening existing (in a today's changelog) link to PR or commit.

[powerman]

And the rationale is simple: in most cases end-users (a target audience for CHANGELOG.md) are interested in closed issues (i.e. actual problems/feature requests) and not in a code which implemented that (commit or PR).

From this point of view it'll be the best to also include in changelog titles of these issues instead of just links, but… just links are probably good enough for start. 😄

[orhun]

Thanks for the details! I agree that it would be nice if this was implemented, can you shoot me an issue for it?