-
Notifications
You must be signed in to change notification settings - Fork 35
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
[chloggen] Add repo-level option to generate multiple changelogs #364
Comments
This was referenced Jul 14, 2023
I think they should be separate files. It'll allow us to render the same entry in different files and with a clean structure. |
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Change logs are written for a particular audience. Some of our repos have more than one audience, each of which is concerned with a different set of changes.
As noted here, the collector-contrib repo should consider end users and component developers as separate audiences. (And some people such as maintainers may be members of both audiences.) End users are concerned with changes to the behavior of the collector, while component developers are concerned with changes to exported elements of the packages.
I propose that
chloggen
be enhanced in such as way that it is possible for each repository to opt into the following:user
,api
)The implementation would involve the introduction of a repo-level configuration file that might look like this:
A repo that opts into these new features would update their
TEMPLATE.yaml
roughly as follows:Open Question:
Should each change log be written to its own file or just broken out within the same file? Separate files could be supported by including a
file
field in thechange_logs
config. Otherwise, this is a matter of updating the embedded template.The text was updated successfully, but these errors were encountered: