slim icon indicating copy to clipboard operation
slim copied to clipboard

Published 20 hours ago • verified publisher icon NASA-AMMOS

[New Process Improvement Need]: Consolidated Release Notes

Open riverma opened this issue 1 year ago • 3 comments

Checked for duplicates

Yes - I've already checked

Category

Information Sharing - documentation design, templates, communication, etc.

Describe the need

We have a need for standards related to "rolling-up" software development release notes (or change log entries) from sub-projects, or multiple repositories, into a summarized release note. This is a bit of a challenging and manually intensive task, so recommendations (or tools to assist) would be greatly valued to save time.

riverma avatar Jul 18 '23 22:07 riverma

CC @GodwinShen @mike-gangl

riverma avatar Jul 18 '23 22:07 riverma

Adding additional scope to this issue ticket:

  • Templates for release notes to help publicize a release
  • Automation to e-mail, IM, etc. release notes to a community to get word out

riverma avatar Mar 21 '24 23:03 riverma

Possible recommendations:

  • Leverage GitHub integrations with your IM channels for automated release (and other) notifications. See: https://slack.github.com
  • Leverage a .github/release.yml template for customizing the look / feel of release files better using labels.
  • Encourage team members to watch repository for release updates, i.e. https://github.blog/changelog/2018-11-27-watch-releases/

riverma avatar Mar 22 '24 00:03 riverma