search

grafana / alloy

OpenTelemetry Collector distribution with programmable pipelines
https://grafana.com/oss/alloy
Apache License 2.0
1.41k stars 204 forks source link

Reconsider how breaking changes are documented #1758

Open ptodev opened 1 month ago

ptodev commented 1 month ago

We currently document breaking changes in both the changelog and in the Release notes doc. Unfortunately, sometimes we forget to update the "Release notes" doc.

Should we add a CI check to make sure that any PR which adds a "breaking change" to the changelog also edits the "Release notes"? Or should we reconsider the need for a Release notes doc, and potentially remove it?

github-actions[bot] commented 1 week ago

This issue has not had any activity in the past 30 days, so the needs-attention label has been added to it. If the opened issue is a bug, check to see if a newer release fixed your issue. If it is no longer relevant, please feel free to close this issue. The needs-attention label signals to maintainers that something has fallen through the cracks. No action is needed by you; your issue will be kept open and you do not have to respond to this comment. The label will be removed the next time this job runs if there is new activity. Thank you for your contributions!