StarlingX/Releases/Release Notes
Contents
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.
- Storyboard Process Release Management Implementation
Important!
- It is worth to spent some time reading the 15 minute [ https://docs.openstack.org/reno/latest/ Reno Documentation].
- Doc Release Notes Management Mailing List.
Tracking
- openstack/stx-clients
- Storyboard Task 26713 Doc: Release Notes Management
- Gerrit Review Doc Release Notes Management
- openstack/stx-config
- Storyboard Task 26514 Doc: Release Notes Management
- Gerrit Review Doc Release Notes Management
- openstack/stx-distcloud
- Storyboard Task 26620 Doc: Release Notes Management
- Gerrit Review Doc Release Notes Management
- openstack/stx-distcloud-client
- Storyboard Task 26732 Doc: Release Notes Management
- Gerrit Review Doc Release Notes Management
- openstack/stx-docs
- openstack/stx-fault
- Storyboard Task 26696 Doc: Release Notes Management
- Gerrit Review Doc Release Notes Management
- openstack/stx-gui
- Storyboard Task 26717 Doc: Release Notes Management
- Gerrit Review Doc Release Notes Management
- openstack/stx-ha
- Storyboard Task 25748 Doc: Release Notes Management
- Gerrit Review Doc Release Notes Management
- openstack/stx-integ
- Storyboard Task 26719 Doc: Release Notes Management
- Gerrit Review Doc Release Notes Management
- openstack/stx-metal
- Storyboard Task 25744 Doc: Release Notes Management
- Gerrit Review Doc Release Notes Management
- openstack/stx-nfv
- Storyboard Task 26667 Doc: Release Notes Management
- Gerrit Review Doc Release Notes Management
- openstack/stx-tools
- Storyboard Task 24554 Doc: Release Notes Management
- Gerrit Review Doc Release Notes Management
- openstack/stx-update
- Storyboard Task 26658 Doc: Release Notes Management
- Gerrit Review Doc Release Notes Management
- openstack/stx-upstream
- Storyboard Task 26722 Doc: Release Notes Management
- Gerrit Review Doc Release Notes Management
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
- Start common development workflow to create your change:
- "Hello My Change"
- New! Create its release notes in reStructuredText, no major effort since title and content might be reused from git commit information:
- tox -e venv -- reno new hello-my-change
- Submit your change for review.
Release Team
- Start development work to prepare the release, this might include git tag.
- Create to generate the Reno Report
- tox -e releasenotes
- 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.