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

Allow generation of changelog for specific components #109

Open
OddBloke opened this issue Jun 23, 2018 · 4 comments
Open

Allow generation of changelog for specific components #109

OddBloke opened this issue Jun 23, 2018 · 4 comments

Comments

@OddBloke
Copy link

I have a workspace that contains a library and a binary (distro-info and ubuntu-distro-info respectively in the examples below). These are released as separate crates, so I would like to maintain their changelogs separately, to make it easier for users of each separate component to understand what it is that changed. I'd like to be able to invoke clog-cli something like this:

clog -r https;//github.com/OddBloke/distro-info-rs --component distro-info
(cd ubuntu-distro-info;
 clog -r https;//github.com/OddBloke/distro-info-rs --component ubuntu-distro-info)

For changes which affect everything, I would like to be able to use an "all" component, so being able to specify more than one component would be ideal:

clog -r https;//github.com/OddBloke/distro-info-rs --component distro-info --component all

(Potentially there could be a way of including/excluding the empty component, which could allow it to serve as the "all" component.)

@hawkw
Copy link

hawkw commented Dec 16, 2021

+1 for this, I'd really like to see a feature like this for releasing tokio-console (which consists of multiple crates). I'd be happy to work on implementing a feature like this.

@cburgdorf
Copy link
Contributor

PRs welcome :D

@hawkw
Copy link

hawkw commented Dec 16, 2021

Great --- I might have some questions :)

@cburgdorf
Copy link
Contributor

Cool! I'd be happy to help. I mean, I haven't worked on this for many years but I'd be honored to be of service for tokio :)

hawkw added a commit to hawkw/clog-lib that referenced this issue Jun 6, 2022
This branch adds a new `path_filters` field to the `Clog` struct,
containing a list of paths in the repository to filter the `git log`
invocation. If there are paths in this list, the `git log` command will
end with `-- <PATHS...>`, which restricts the list of returned commits
to those which modify certain paths in the repo.

This is useful for cases where a project contains multiple crates or
binaries that should have separate changelogs. See also
clog-tool/clog-cli#109 for a related issue.

BREAKING CHANGE:

This adds a new field to the `Clog` struct. This is not backwards
compatible, as adding new fields will break exhaustive pattern matching
on that struct. See [the Rust API Guidelines][1] for details.

[1]: https://rust-lang.github.io/api-guidelines/future-proofing.html#structs-have-private-fields-c-struct-private
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants