Add proper change log to github releases - Githubissues

DataDog / helm-charts

Helm charts for Datadog products

Apache License 2.0

349 stars 1.02k forks source link

Add proper change log to github releases #1282

Open florianmutter opened 10 months ago

florianmutter commented 10 months ago

Right now the release notes do not contain any usefuly information:

grafik

Proper changelog is available. This same information should be included in the github release.

This would allow dependency update tools like Dependabot or renovate to show a proper changelog in update PRs.

To be extra helpful the changelog should incode changes that happened in the datadog agent as a sub list. Something like:

Datadog Agent update to version 7.50.0. Changes from last version:

7.50.0

Agent

Prelude

Release on: 2023-12-19

Please refer to the 7.50.0 tag on integrations-core for the list of changes on the Core Checks

Upgrade Notes

The win32_event_log check has moved from Python ...

7.49.1

ronniecoleman-hadrian commented 2 days ago

would be great to have a section to add what relevant github issues were addressed by a given release. maybe even a section for "manifest" of what dependency versions exist in that release of the helm chart (which ones were added/updated should go in the changelog, but this manifest section should be comprehensive, even if a dependency wasn't updated).