git-phlow icon indicating copy to clipboard operation
git-phlow copied to clipboard

As a PO I want completely automated release notes

Open buep opened this issue 7 years ago • 1 comments

It can be broken down into several smaller achievements.

  • As part of the release process the release note is pushed as well, in this case as markdown to github.
  • The release note contain both changelog based on commit history with information fra mentioned issues, AND human written content.
  • Human written content is two part: an introductory snippets nicely presenting how cool this release are AND accompanying small 1-2 liners for selected relevant issues
  • The introductory snippet is written and committed based on next planned release and should be committed together with the version increment for the next release. It is a markdown document.
  • The snippets for selected relevant issues are committed together with the change itself.

The process:

  1. Bump version and present next release. 1.1. Bump version number in version number file to match next planned release. 1.2. Add with the version increment commit also the markdown file presenting the next release.
  2. Work fixing issues... Remember if relevant, you need to contribute issue specific release note content.
  3. Clicking release, the release note automation pick up the presentation and snippets and publish the changelog.

Goals: always ready to release and have an release note ready.

buep avatar Sep 12 '17 09:09 buep

This is related to #102

groenborg avatar Sep 13 '17 12:09 groenborg