-
Notifications
You must be signed in to change notification settings - Fork 2.4k
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
Create a list of components for release notes #27270
Comments
Sounds good to me. Checking for valid components, and consistent formatting especially (for me at least) would be very helpful. Couple thoughts, maybe not entirely relevant: I'd suggest the best time to validate component naming format is on open PR's by just updating the existing workflow. It would be nice to fail the job if the component is not on the list of valid components, that way they're formatted "at the source" by the contributor. If we wait until creating the release we'd run into some kind of translation/mapping problem where we'd need to guess possible component names and then map them to the proper format (if we're doing it programmatically), or rely on the person creating the release to go through the manual process. Once we have a uniform component list, it would also be good to sort release notes by name. This would make it easier to check if a given component was changed, and then see all changes (at least for a speciifc category of change) for that component together. |
You nailed it. Yes, chloggen would fail the build if the component is not in the list, and this would allow us to build changelog per component. My ultimate goal is to drive changelog to display as generated in each component READMEs that desires it. |
This issue has been inactive for 60 days. It will be closed in 60 days if there is no activity. To ping code owners by adding a component label, see Adding Labels via Comments, or if you are unsure of which component this issue relates to, please ping |
This issue has been inactive for 60 days. It will be closed in 60 days if there is no activity. To ping code owners by adding a component label, see Adding Labels via Comments, or if you are unsure of which component this issue relates to, please ping |
This issue has been inactive for 60 days. It will be closed in 60 days if there is no activity. To ping code owners by adding a component label, see Adding Labels via Comments, or if you are unsure of which component this issue relates to, please ping |
Component(s)
No response
Is your feature request related to a problem? Please describe.
With open-telemetry/opentelemetry-go-build-tools#402, we now can set up a list of valid components in the config.yml file of the .chloggen folder.
The list of components should include all the valid components we expose in this repository.
This would help when it's time to consume release notes as the names would be standardized.
Describe the solution you'd like
We would adopt a script to generate the contents of the list based off criteria of our choice. I would be in favor of considering any metadata.yaml file parent folder as a valid component. This is open for feedback.
First option:
This means the changelog would contain entries such as:
receiver/filelogreceiver
.Second option, for example:
We can also use a Go package name such as
go.opentelemetry.io/contrib/receiver/filelogreceiver
.Describe alternatives you've considered
No response
Additional context
No response
The text was updated successfully, but these errors were encountered: