gateway icon indicating copy to clipboard operation
gateway copied to clipboard

Managing the Changelog

Open danehans opened this issue 3 years ago • 2 comments

The changelog was not updated as part of the RC1 release. A changelog was generated as part of the release. Should we remove the existing changelog and just use the GH release changelogs?

cc: @youngnick @LukeShu @arkodg

danehans avatar Aug 31 '22 21:08 danehans

  • for now, we could leave the generated CHANGELOG as is, and maybe cleanup the older https://github.com/envoyproxy/gateway/tree/main/changelogs
  • the GHA https://github.com/softprops/action-gh-release#-external-release-notes allows us to use any external Changelog generator For rc2 we should consider something more sophisticated that is based off contents/labels in the PRs

arkodg avatar Aug 31 '22 21:08 arkodg

xref #325

danehans avatar Sep 01 '22 16:09 danehans

Reopened this issue to act as a recurring reminder to create a changelog per release.

danehans avatar Sep 30 '22 16:09 danehans

This issue can be reclosed after https://github.com/envoyproxy/gateway/pull/325 has been merged.

danehans avatar Sep 30 '22 16:09 danehans

I liked how https://github.com/envoyproxy/gateway/releases/tag/v0.2.0-rc1 acknowledged community contributions, we should consider something similar going forward

arkodg avatar Sep 30 '22 17:09 arkodg

@arkodg regarding https://github.com/envoyproxy/gateway/issues/324#issuecomment-1263820704, GitHub automatically acknowledges new contributors when cutting a release. The same was done for RC1.

danehans avatar Oct 04 '22 15:10 danehans

yeah looks like we've preserved it, which is great :) , but now i'm confused as to how https://github.com/envoyproxy/gateway/blob/main/changelogs/0.2.0-rc2.yaml is being presented to the user

arkodg avatar Oct 04 '22 17:10 arkodg

Update changelog -> release notes.

danehans avatar Oct 11 '22 21:10 danehans

Closed by https://github.com/envoyproxy/gateway/pull/475

danehans avatar Oct 18 '22 21:10 danehans