Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add reno releasenote configuration #34

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,10 @@ services:
- docker

install:
- git fetch --unshallow --tags
- pip install PyYAML
- pip install virtualenv
- pip install reno
- |
test -e Gemfile || cat <<EOF > Gemfile
source 'https://rubygems.org'
Expand All @@ -25,6 +27,7 @@ env:
before_script:
- set -o pipefail
- make test | tail
- reno -v lint $PWD | tail

script:
- test ! -e .kitchen.yml || bundle exec kitchen test -t tests/integration
Expand Down
59 changes: 59 additions & 0 deletions releasenotes/config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
---
# Usage:
#
# reno list
# reno new slug-title --edit
# reno report --no-show-source

# Change prelude_section_name to 'summary' from default value prelude
prelude_section_name: summary
show_source: False
sections:
# summary/prelude section is always included
- [features, New Features]
- [issues, Known Issues]
- [fixes, Bug Fixes]
- [other, Other Notes]
template: |
---
# Author the following sections or remove the section if it is not related.
# Use one release note per a feature.
#
# If you miss a section from the list below, please first submit a review
# adding it to releasenotes/config.yaml.
#
summary: >
This section is not mandatory. Use it to highlight the change.

features:
- Use list to record summary of features.
- |
Provide detailed description with examples.
Format with reStructuredText.

.. code-block:: text

provide model/formula pillar snippets

issues:
- Use list to record known limitations.

fixes:
- Use list to record summary of fixes.
Quick and dirty `git log --oneline`.

other:
- Author additional notes for the release.
- Format with reStructuredText.
- |
Use this section if note is not related to one of the common sections:
features, issues, upgrade, deprecations, security, fixes, api, cli

* list item 1
* list item 2

.. code-block:: yaml

formula:
example:
enabled: true
18 changes: 18 additions & 0 deletions releasenotes/notes/add-releasenotes-9c076c7ee8fbe2a4.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
summary: >
Use "reno", an releasenotes configuration tool to record release notes.
Documentation: https://docs.openstack.org/reno/latest

To list/create/show release notes, run following commands:

.. code-block:: shell

reno list
reno new releasenote-slug-title --edit
# use favored $EDITOR to update the note
# git add/commit releasenotes/* as usual
reno report --no-show-source

other:
- |
Added `reno <https://docs.openstack.org/reno/latest>_` configuration to the repository.