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 config option to include the changes of the dependent packages in the changelog of the package #671

Closed
MarcoIeni opened this issue Apr 5, 2023 · 1 comment · Fixed by #904
Labels
enhancement New feature or request priority:medium We care about this

Comments

@MarcoIeni
Copy link
Owner

MarcoIeni commented Apr 5, 2023

Motivations

At the moment, the changelogs contain only the changes of the current package.
It would be nice to add the option to include the changes of all dependent packages of the workspace (not dev-dependencies).

For monorepos, if you go with the single changelog strategy, the changelog will contain all the changes of your "main" crate and its dependencies.

Solution

add the commits of the dependent dependencies here.
Remove duplicates.

Questions

should we include just the changes of direct dependencies? Or should this also be recursive?

For example if we the following dependency graph:

A -> B -> C.

Should updates of the local dependency C be in the changelog of package A?

Answer: we could start with a "direct dependency" approach, i.e. only include the changes of B.

I'm still not sure if this makes sense 🤔 Feedback, anyone?

@MarcoIeni MarcoIeni added the enhancement New feature or request label Apr 5, 2023
@MarcoIeni MarcoIeni added the priority:medium We care about this label Apr 5, 2023
@MarcoIeni
Copy link
Owner Author

MarcoIeni commented Apr 10, 2023

Another option: let's have a list of include in the changelog where we explicitly list packages we want to include changes.

For example, in release-plz I would use it to include the changes of release-plz-core.

Since we have so many option for the changelog, we should create a subsection for it.

EDIT: this is my preferred option.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request priority:medium We care about this
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant