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

Generate changelog for submodules #52

Open
bachp opened this issue Jan 26, 2022 · 1 comment
Open

Generate changelog for submodules #52

bachp opened this issue Jan 26, 2022 · 1 comment
Assignees
Labels
feature/request New feature or request

Comments

@bachp
Copy link
Contributor

bachp commented Jan 26, 2022

Is your feature request related to a problem? Please describe.
If my repository contains submodules and I have commits updating the submodule, I only see the a commit doing the update.
The information what changed in the submodule is not visible.

If the submodule also follow the same commit convention I would like to have a way to also include the submodule commits in my changelog.

Describe the solution you'd like

Add an option to recurse into submodules.
With this option enabled, git-cliff would, whenever it encounters a commit changing a submodule revision, recurse into this submodule.
It would then get the list of all commits included in this version change and include them in the current changelog. Maybe separated by submodule to allow nicely group them in the output.

Describe alternatives you've considered

  • Implement this behaviour in an external script and merge the generated MRs
  • Use subtrees instead of submodules

Additional context

@bachp bachp added the feature/request New feature or request label Jan 26, 2022
@snaeil
Copy link

snaeil commented Oct 19, 2022

I don't know if it's possible but it would be awesome to be able to use git-cliff as @bachp described for git subtree merging.

Example for subtree merging can be found here.

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

No branches or pull requests

3 participants