aws / secrets-store-csi-driver-provider-aws

The AWS provider for the Secrets Store CSI Driver allows you to fetch secrets from AWS Secrets Manager and AWS Systems Manager Parameter Store, and mount them into Kubernetes pods.
Apache License 2.0
459 stars 130 forks source link

Consider adding a changelog or useful notes to Github releases #386

Closed gunzy83 closed 2 weeks ago

gunzy83 commented 2 months ago

Hello,

This is not really a feature request for this program but the repo itself. When operating a cluster we have to check changelogs of all of the applications we are running to ensure there are no breaking changes or changes that would affect how we operate the application.

We are now also using Renovate to automate helm upgrades (via PRs) to our Pulumi managed EKS clusters and this repo does not include either a CHANGELOG.md file anywhere and the Github releases do not include any useful information about what was actually released. Adding either of these will ease the burden of checking all commits between versions.

I realise that this will be a change to the release workflow (which looks to be manual right now) but there are tools like Release Please that make this easy if you are using conventional commits.

Thanks.

simonmarty commented 2 weeks ago

I generated release notes to our various GitHub releases. We use chart-releaser to release new versions of our helm chart which creates the release in GitHub. I don't know that that tool supports making changelogs.

You can always look at the git history. We tag each commit with the version number.

gunzy83 commented 2 weeks ago

I see the releases now have descriptive notes on them, which works just fine. While our primary repo is up-to-date, I tested this on a test repo and renovate generates a nice log from the release objects:

Before: image

After: image

Thanks again.