Including the release notes in the tag seems like a good idea. However, I don't think there is an obvious way to automate the process, since Beam's primary release tool is shell scripts :) and Github tag summaries are a Github feature, not a standard git feature. Would it be sufficient to manually copy the release notes into the tag summary?
On Tue, May 19, 2020 at 6:18 PM Julien Phalip <jpha...@gmail.com> wrote: > Hi, > > I'm working with customers who would like to be automatically notified > when new Beam releases come out. They'd also like to see the release notes > so they know what changes were made. > > I know that these announcements are already sent to the user@ and dev@ > mailing lists. However, they're not easy to catch automatically as they're > intermingled with lots of other messages in those lists. > > One possible solution would be to leverage the Beam project's releases Atom > feed <https://github.com/apache/beam/releases.atom> on Github (see also > the web version <https://github.com/apache/beam/releases>). This allows, > for example, to automatically publish a notification in Slack > <https://slack.com/help/articles/218688467-Add-RSS-feeds-to-Slack> when a > new release comes out. However, the Atom feed only contains the tag names > without any description because the release notes aren't recorded in Github. > > Do you think that the Beam release process could be extended to call the > Github > Releases API <https://developer.github.com/v3/repos/releases/> to > automatically publish the release notes in Github? > > As an example, see the Helm project's releases page > <https://github.com/helm/helm/releases>, where release notes are created > using a template > <https://github.com/helm/helm/blob/master/scripts/release-notes.sh> and > published with a tool called goreleaser <https://goreleaser.com/>. > > Thank you, > > Julien >
