Andreas Specovius / ctools

Commit 08cf3fa31d141df3b9b0c619b2fdd29b32147c4b

Authored by Jürgen Knödlseder
1 parent fb7cd3f9

Update developer documentation

Inline Side-by-side
Showing 6 changed files with 28 additions and 7 deletions
doc/source/develop/releasing/check.png 0 → 100644
View file @08cf3fa

354 KB
doc/source/develop/releasing/check.rst 0 → 100755
  View file @08cf3fa
  1 +.. _dev_releasing_check:
  2 +
  3 +Launch the release check pipeline
  4 +=================================
  5 +
  6 +Once you have checked that the code is complete and unit tests were added
  7 +for all new code, connect to
  8 +`Jenkins <https://cta-jenkins.irap.omp.eu/view/Release/job/release-check-ctools/>`_
  9 +and launch the ctools release check pipeline by clicking on the
  10 +``Build with Parameters`` link:
  11 +
  12 +.. figure:: check.png
  13 + :width: 600px
  14 + :align: center
  15 +
  16 + *ctools release check pipeline*
  17 +
  18 +In case that any errors occur during running the release check pipeline, you
  19 +should fix the errors and re-run the pipeline until it terminates with success.
... ...
doc/source/develop/releasing/index.rst
  View file @08cf3fa
... ... @@ -9,7 +9,8 @@ To create a new ctools release you have to go through the following steps:
9 9 :maxdepth: 1
10 10  
11 11 create
12   - pipeline
  12 + check
  13 + release
13 14 tag
14 15 merge
15 16 devel
... ...
doc/source/develop/releasing/pipeline.png deleted
View file @fb7cd3f

475 KB
doc/source/develop/releasing/release.png 0 → 100644
View file @08cf3fa

421 KB
doc/source/develop/releasing/pipeline.rst renamed to doc/source/develop/releasing/release.rst
  View file @08cf3fa
... ... @@ -3,16 +3,17 @@
3 3 Launch the release pipeline
4 4 ===========================
5 5  
6   -Now you should connect to
7   -`Jenkins <https://cta-jenkins.irap.omp.eu>`_
8   -and launch the ctools release pipeline by clicking on the dedicated
9   -button:
  6 +Once you have made a final check that all the User documentation is updated
  7 +and accurate, connect to
  8 +`Jenkins <https://cta-jenkins.irap.omp.eu/view/Release/job/release-ctools/>`_
  9 +and launch the ctools release pipeline by clicking on the
  10 +``Build with Parameters`` link:
10 11  
11   -.. figure:: pipeline.png
  12 +.. figure:: release.png
12 13 :width: 600px
13 14 :align: center
14 15  
15 16 *ctools release pipeline*
16 17  
17 18 In case that any errors occur during running the release pipeline, you should
18   -fix the errors and rerun the pipeline until it terminates with success.
  19 +fix the errors and re-run the pipeline until it terminates with success.
... ...