Merge "Extend FAQ with answer of how to create a new release note"

This commit is contained in:
Jenkins 2015-12-01 17:24:17 +00:00 committed by Gerrit Code Review
commit 53fbef7a22

View File

@ -12,11 +12,11 @@ elsewhere.
:depth: 2
How do I
=========
How do I...
===========
…create a migration script template?
------------------------------------
...create a migration script template?
--------------------------------------
Using the ``alembic revision`` command, e.g::
@ -26,3 +26,31 @@ Using the ``alembic revision`` command, e.g::
For more information see the `alembic documentation`_.
.. _`alembic documentation`: https://alembic.readthedocs.org/en/latest/tutorial.html#create-a-migration-script
...create a new release note?
-----------------------------
By running ``reno`` command via tox, e.g::
$ tox -e venv -- reno new version-foo
venv create: /home/foo/ironic/.tox/venv
venv installdeps: -r/home/foo/ironic/test-requirements.txt
venv develop-inst: /home/foo/ironic
venv runtests: PYTHONHASHSEED='0'
venv runtests: commands[0] | reno new version-foo
Created new notes file in releasenotes/notes/version-foo-ecb3875dc1cbf6d9.yaml
venv: commands succeeded
congratulations :)
$ git status
On branch test
Untracked files:
(use "git add <file>..." to include in what will be committed)
releasenotes/notes/version-foo-ecb3875dc1cbf6d9.yaml
Then edit the result file.
For more information see the `reno documentation`_.
.. _`reno documentation`: http://docs.openstack.org/developer/reno/usage.html#creating-new-release-notes