From 011d03723bfb28a0098f036d0e9cbdfa8765623c Mon Sep 17 00:00:00 2001 From: Lucas Alvares Gomes Date: Mon, 30 Nov 2015 12:44:05 +0000 Subject: [PATCH] Extend FAQ with answer of how to create a new release note The question was raised in the #openstack-ironic IRC channel Change-Id: I7d72adc96d606e6062930fe3c9e653ba369e621b --- doc/source/dev/faq.rst | 36 ++++++++++++++++++++++++++++++++---- 1 file changed, 32 insertions(+), 4 deletions(-) diff --git a/doc/source/dev/faq.rst b/doc/source/dev/faq.rst index 1277bfaf30..7bf63a0f55 100644 --- a/doc/source/dev/faq.rst +++ b/doc/source/dev/faq.rst @@ -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 ..." 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