Jump to: navigation, search

Difference between revisions of "StarlingX/Releases/Release Notes"

(StarlingX)
(Tracking)
 
(22 intermediate revisions by the same user not shown)
Line 9: Line 9:
 
* [http://lists.starlingx.io/pipermail/starlingx-discuss/2018-August/000690.html Doc Release Notes Management Mailing List].
 
* [http://lists.starlingx.io/pipermail/starlingx-discuss/2018-August/000690.html Doc Release Notes Management Mailing List].
  
== StarlingX ==
+
=== Tracking ===
  
 
* openstack/stx-clients
 
* openstack/stx-clients
 +
** Storyboard Task [https://storyboard.openstack.org/#!/story/2003101 26713 Doc: Release Notes Management]
 +
** Gerrit Review [https://review.openstack.org/605094 Doc Release Notes Management]
 
* openstack/stx-config
 
* openstack/stx-config
 +
** Storyboard Task [https://storyboard.openstack.org/#!/story/2003101 26514 Doc: Release Notes Management]
 +
** Gerrit Review [https://review.openstack.org/#/c/603257/ Doc Release Notes Management]
 +
* openstack/stx-distcloud
 +
** Storyboard Task [https://storyboard.openstack.org/#!/story/2003101 26620 Doc: Release Notes Management]
 +
** Gerrit Review [https://review.openstack.org/#/c/604481/ Doc Release Notes Management]
 +
* openstack/stx-distcloud-client
 +
** Storyboard Task [https://storyboard.openstack.org/#!/story/2003101 26732 Doc: Release Notes Management]
 +
** Gerrit Review [https://review.openstack.org/605305 Doc Release Notes Management]
 
* openstack/stx-docs
 
* openstack/stx-docs
 
* openstack/stx-fault
 
* openstack/stx-fault
 +
** Storyboard Task [https://storyboard.openstack.org/#!/story/2003101 26696 Doc: Release Notes Management]
 +
** Gerrit Review [https://review.openstack.org/604945 Doc Release Notes Management]
 
* openstack/stx-gui
 
* openstack/stx-gui
 +
** Storyboard Task [https://storyboard.openstack.org/#!/story/2003101 26717 Doc: Release Notes Management]
 +
** Gerrit Review [https://review.openstack.org/605120 Doc Release Notes Management]
 
* openstack/stx-ha
 
* openstack/stx-ha
 +
** Storyboard Task [https://storyboard.openstack.org/#!/story/2003101 25748 Doc: Release Notes Management]
 +
** Gerrit Review [https://review.openstack.org/#/c/599465/ Doc Release Notes Management]
 
* openstack/stx-integ
 
* openstack/stx-integ
* openstack/stx-manifest
+
** Storyboard Task [https://storyboard.openstack.org/#!/story/2003101 26719 Doc: Release Notes Management]
 +
** Gerrit Review [https://review.openstack.org/605130 Doc Release Notes Management]
 
* openstack/stx-metal
 
* openstack/stx-metal
 +
** Storyboard Task [https://storyboard.openstack.org/#!/story/2003101 25744 Doc: Release Notes Management]
 +
** Gerrit Review [https://review.openstack.org/#/c/599454 Doc Release Notes Management]
 
* openstack/stx-nfv
 
* openstack/stx-nfv
* openstack/stx-root
+
** Storyboard Task [https://storyboard.openstack.org/#!/story/2003101 26667 Doc: Release Notes Management]
* openstack/stx-tis-repo
+
** Gerrit Review [https://review.openstack.org/#/c/604851 Doc Release Notes Management]
 
* openstack/stx-tools
 
* openstack/stx-tools
** [https://storyboard.openstack.org/#!/story/2003101 Storyboard Task 24554 Doc: Release Notes Management]
+
** Storyboard Task [https://storyboard.openstack.org/#!/story/2003101 24554 Doc: Release Notes Management]
** [https://review.openstack.org/#/c/590798/ Doc Release Notes Management]
+
** Gerrit Review [https://review.openstack.org/#/c/590798/ Doc Release Notes Management]
 
* openstack/stx-update
 
* openstack/stx-update
 +
** Storyboard Task [https://storyboard.openstack.org/#!/story/2003101 26658 Doc: Release Notes Management]
 +
** Gerrit Review [https://review.openstack.org/#/c/604840/ Doc Release Notes Management]
 
* openstack/stx-upstream
 
* openstack/stx-upstream
 +
** Storyboard Task [https://storyboard.openstack.org/#!/story/2003101 26722 Doc: Release Notes Management]
 +
** Gerrit Review [https://review.openstack.org/605158 Doc Release Notes Management]
  
 
== Baseline ==
 
== Baseline ==

Latest revision as of 02:45, 26 September 2018

Intro

StarlingX/Docs_and_Infra is working in collaboration with Tech Writers team to document StarlingX APIs, this page reflects the research on what it means for StarlingX.


Important!

Tracking

Baseline

Release Notes Management baseline is ready for review, once this is approved it will be ported to the rest of our projects.w:

Demo

To generate our Release Note and Report a small amount of effort is required from both our Developers and our Release team. Here you have a demo for Milestone branch m/2018.08 including both efforts:

Grouping

There is a convention to follow how Release Notes are grouped:

  • features
  • issues
  • upgrade
  • deprecations
  • critical
  • security
  • fixes
  • other

See this link as an example:

Call to Action

In my limited understanding a typical flow would be as follows:

Developer

  1. Start common development workflow to create your change:
    1. "Hello My Change"
  2. New! Create its release notes in reStructuredText, no major effort since title and content might be reused from git commit information:
    1. tox -e venv -- reno new hello-my-change
  3. Submit your change for review.

Release Team

  1. Start development work to prepare the release, this might include git tag.
  2. Create to generate the Reno Report
    1. tox -e releasenotes
  3. Submit your change for review.


In OpenStack it seems OpenStack Release Bot takes care of the Release Process.
See Nova Release Notes for how it looks like.