Skip to content

Commit

Permalink
Add reno releasenote configuration
Browse files Browse the repository at this point in the history
  • Loading branch information
epcim committed Jul 11, 2017
1 parent b2247fc commit 4f432d1
Show file tree
Hide file tree
Showing 3 changed files with 79 additions and 0 deletions.
2 changes: 2 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ services:
install:
- pip install PyYAML
- pip install virtualenv
- pip install reno
- |
test -e Gemfile || cat <<EOF > Gemfile
source 'https://rubygems.org'
Expand All @@ -25,6 +26,7 @@ env:
before_script:
- set -o pipefail
- make test | tail
- reno lint | 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 long 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.

0 comments on commit 4f432d1

Please sign in to comment.