Release Notes Contributor Guide

Release Notes Contributor Guide

Release notes for StarlingX projects are managed using Reno allowing release notes go through the same review process used for managing code changes. Release documentation information comes from YAML source files stored in the project repository, that when built in conjuction with RST source files, generate HTML files. More details about the Reno Release Notes Manager can be found at: https://docs.openstack.org/reno

Locations

StarlingX Release Notes documentation exists in the following projects:

  • stx-clients: StarlingX Client Libraries
  • stx-config: StarlingX System Configuration Management
  • stx-distcloud: StarlingX Distributed Cloud
  • stx-distcloud-client: StarlingX Distributed Cloud Client
  • stx-fault: StarlingX Fault Management
  • stx-gui: StarlingX Horizon plugins for new StarlingX services
  • stx-ha: StarlingX High Availability/Process Monitoring/Service Management
  • stx-integ: StarlingX Integration and Packaging
  • stx-metal: StarlingX Bare Metal and Node Management, Hardware Maintenance
  • stx-nfv: StarlingX NFVI Orchestration
  • stx-tools: StarlingX Build Tools
  • stx-update: StarlingX Installation/Update/Patching/Backup/Restore
  • stx-upstream: StarlingX Upstream Packaging

Directory Structures

The directory structure of Release documentation under each StarlingX project repository is fixed. Here is an example showing stx-confi StarlingX System Configuration Management:

releasenotes/
├── notes
│   └── release-summary-6738ff2f310f9b57.yaml
└── source
    ├── conf.py
    ├── index.rst
    └── unreleased.rst

The initial modifications and additions to enable the API Documentation service in each StarlingX project are as follows:

  • .gitignore modifications to ignore the building directories and HTML files for the Release Notes
  • .zuul.yaml modifications to add the jobs to build and publish the api-ref document
  • releasenotes/notes/ directory creation to store your release notes files in YAML format
  • releasenotes/source directory creation to store your API Reference project directory
  • releasenotes/source/conf.py configuration file to determine the HTML theme, Sphinx extensions and project information
  • releasenotes/source/index.rst source file to create your index RST source file
  • releasenotes/source/unrelased.rst source file to avoid breaking the real release notes build job on the master branch
  • doc/requiremets.txt modifications to add the os-api-ref Sphinx extension
  • tox.ini modifications to add the configuration to build the API reference locally

See stx-config [Doc] Release Notes Management as an example of this first commit: https://review.openstack.org/#/c/603257/

Once the Release Notes Documentation service has been enabled, you can create a new release notes.

Release Notes Files

The following shows the YAML source file for the stx-config StarlingX System Configuration Management: Release Summary r/2018.10

stx-config/releasenotes/
├── notes
│   └── release-summary-6738ff2f310f9b57.yaml

To create a new release note that document your code changes via tox newnote environment:

$ tox -e newnote hello-my-change

A YAML source file is created with a unique name under releasenote/notes/ directory:

stx-config/releasenotes/
├── notes
│   ├── hello-my-change-dcef4b934a670160.yaml

The content are gound into logical sections based in the default template used by reno:

features
issues
upgrade
deprecations
critical
security
fixes
other

Modify the content in the YAML source file based on reStructuredText format.

Closing Out a Bug or Story

If you are modifying a document as a result of a defect or feature that is associated with a StoryBoard Story or Launchpad Bug, you must take steps to link your submission (Gerrit Review) to the story or bug.

To link a story, add the following lines in your commit message. Be sure to use the actual story ID and task ID with the commit:

  • Story: $story_id
  • Task: $task_id

Following is an example that links a Gerrit Review with Story 2003375 and Task 2444:

Change the tox.ini directory regarding tox.ini dependencies

Story: 2003375
Task: 24444

NOTE: You must provide a blank line before the lines used to identify the story and the task. If you do not provide this line, your submission will not link to the Storyboard’s story.

To link a bug, add the approprite lines in your commit message. Be sure to provide the actual bug numbers:

  • Closes-Bug: $bug_id
  • Partial-Bug: $bug_id
  • Related-Bug: $bug_id

If your fix requires multiple commits, use “Partial-Bug” for all the commits except the final one. For the final commit, use “Closes-Bug”.

Following is an example commit message that closes out bug 1804024:

AIO Hardware Requirements: Updated AIO HW requirements.

Added Small HW form factor information simplex/duplex
AIO hardware requirements.

Closes-Bug: #1804024

When you associate a story or bug with a Gerrit review, Gerrit automatically updates the status of the story or bug once the commit is merged. Again, be sure to provide a blank line just before the line identifying the bug.

You can find more information on the StarlingX code submission guidelines on the wiki.

To see the list of defects against StarlingX, see the Launchpad Application.

Developer Workflow

  1. Start common development workflow to create your change: “Hello My Change”.
  2. Create its release notes, no major effort since title and content might be reused from the Git commit information.
  3. Add your change including its release notes and submit for review.

Release Team Workflow

  1. Start development work to prepare the release. This might include a Git tag.
  2. Generate the Reno Report.
  3. Add your change and submit for review.
Creative Commons Attribution 3.0 License

Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.