diff --git a/doc/source/develop/releasing/create.rst b/doc/source/develop/releasing/create.rst index 1b50385..297b4f4 100644 --- a/doc/source/develop/releasing/create.rst +++ b/doc/source/develop/releasing/create.rst @@ -22,7 +22,7 @@ The GammaLib release is created by invoking the release manager: To create a new release type ``1``. You will then be guided through a number of questions. In the example below we show how you go from the development -version ``1.2.0.dev1`` to the release ``1.2.0``. The first step is to create +version ``1.2.0.dev`` to the release ``1.2.0``. The first step is to create a ``release`` branch. .. code-block:: bash @@ -37,8 +37,8 @@ Then you have to set the version number of the release. .. code-block:: bash - Step 2: Current GammaLib version is '1.2.0.dev1'. Do you want to change the package version? (y/n): y - Current GammaLib version is '1.2.0.dev1'. Please enter new GammaLib version: 1.2.0 + Step 2: Current GammaLib version is '1.2.0.dev'. Do you want to change the package version? (y/n): y + Current GammaLib version is '1.2.0.dev'. Please enter new GammaLib version: 1.2.0 Change version to '1.2.0'? (y/n): y GammaLib version changed to '1.2.0' diff --git a/doc/source/develop/releasing/devel.rst b/doc/source/develop/releasing/devel.rst index c4ac720..4906178 100644 --- a/doc/source/develop/releasing/devel.rst +++ b/doc/source/develop/releasing/devel.rst @@ -34,9 +34,9 @@ Select ``2`` and enter the new version number: .. code-block:: bash - Current GammaLib version is '1.2.0'. Please enter new GammaLib version: 1.3.0.dev1 - Change version to '1.3.0.dev1'? (y/n): y - GammaLib version changed to '1.3.0.dev1' + Current GammaLib version is '1.2.0'. Please enter new GammaLib version: 1.3.0.dev + Change version to '1.3.0.dev'? (y/n): y + GammaLib version changed to '1.3.0.dev' [1] Make a new release [2] Set the package version in current branch @@ -59,8 +59,8 @@ Now commit the changes by chosing ``4``: M gammalib.pc.in M sonar-project.properties Commit all changes? (y/n): y - Please enter a commit message: Update to release version 1.3.0.dev1 - [devel d44a7d6] Update to release version 1.3.0.dev1 + Please enter a commit message: Update to release version 1.3.0.dev + [devel d44a7d6] Update to release version 1.3.0.dev 6 files changed, 7 insertions(+), 7 deletions(-) [1] Make a new release diff --git a/doc/source/develop/releasing/index.rst b/doc/source/develop/releasing/index.rst index 3e6deb2..b686bed 100644 --- a/doc/source/develop/releasing/index.rst +++ b/doc/source/develop/releasing/index.rst @@ -17,6 +17,8 @@ To create a new GammaLib release you have to go through the following steps: .. important:: - Before releasing the software please make sure that you have **added unit - tests for all new code** and that you have **updated the User documentation** - if necessary. + Before releasing the software please make sure that you have + + * added unit tests for all new code + * added a page about the software changes to the release history + * updated the User documentation if necessary