Sergio Hernández Cadena / gammalib

Commit 137c12f16d977b9081027551563cb3f77b938ad2

Authored by Jürgen Knödlseder
1 parent 00413f47

Update developer documentation

Inline Side-by-side
Showing 3 changed files with 13 additions and 11 deletions
doc/source/develop/releasing/create.rst
  View file @137c12f
... ... @@ -22,7 +22,7 @@ The GammaLib release is created by invoking the release manager:
22 22  
23 23 To create a new release type ``1``. You will then be guided through a number
24 24 of questions. In the example below we show how you go from the development
25   -version ``1.2.0.dev1`` to the release ``1.2.0``. The first step is to create
  25 +version ``1.2.0.dev`` to the release ``1.2.0``. The first step is to create
26 26 a ``release`` branch.
27 27  
28 28 .. code-block:: bash
... ... @@ -37,8 +37,8 @@ Then you have to set the version number of the release.
37 37  
38 38 .. code-block:: bash
39 39  
40   - Step 2: Current GammaLib version is '1.2.0.dev1'. Do you want to change the package version? (y/n): y
41   - Current GammaLib version is '1.2.0.dev1'. Please enter new GammaLib version: 1.2.0
  40 + Step 2: Current GammaLib version is '1.2.0.dev'. Do you want to change the package version? (y/n): y
  41 + Current GammaLib version is '1.2.0.dev'. Please enter new GammaLib version: 1.2.0
42 42 Change version to '1.2.0'? (y/n): y
43 43 GammaLib version changed to '1.2.0'
44 44  
... ...
doc/source/develop/releasing/devel.rst
  View file @137c12f
... ... @@ -34,9 +34,9 @@ Select ``2`` and enter the new version number:
34 34  
35 35 .. code-block:: bash
36 36  
37   - Current GammaLib version is '1.2.0'. Please enter new GammaLib version: 1.3.0.dev1
38   - Change version to '1.3.0.dev1'? (y/n): y
39   - GammaLib version changed to '1.3.0.dev1'
  37 + Current GammaLib version is '1.2.0'. Please enter new GammaLib version: 1.3.0.dev
  38 + Change version to '1.3.0.dev'? (y/n): y
  39 + GammaLib version changed to '1.3.0.dev'
40 40  
41 41 [1] Make a new release
42 42 [2] Set the package version in current branch
... ... @@ -59,8 +59,8 @@ Now commit the changes by chosing ``4``:
59 59 M gammalib.pc.in
60 60 M sonar-project.properties
61 61 Commit all changes? (y/n): y
62   - Please enter a commit message: Update to release version 1.3.0.dev1
63   - [devel d44a7d6] Update to release version 1.3.0.dev1
  62 + Please enter a commit message: Update to release version 1.3.0.dev
  63 + [devel d44a7d6] Update to release version 1.3.0.dev
64 64 6 files changed, 7 insertions(+), 7 deletions(-)
65 65  
66 66 [1] Make a new release
... ...
doc/source/develop/releasing/index.rst
  View file @137c12f
... ... @@ -17,6 +17,8 @@ To create a new GammaLib release you have to go through the following steps:
17 17  
18 18  
19 19 .. important::
20   - Before releasing the software please make sure that you have **added unit
21   - tests for all new code** and that you have **updated the User documentation**
22   - if necessary.
  20 + Before releasing the software please make sure that you have
  21 +
  22 + * added unit tests for all new code
  23 + * added a page about the software changes to the release history
  24 + * updated the User documentation if necessary
... ...