diff --git a/doc/source/develop/releasing/check.png b/doc/source/develop/releasing/check.png new file mode 100644 index 0000000..fb1ab8b --- /dev/null +++ b/doc/source/develop/releasing/check.png diff --git a/doc/source/develop/releasing/check.rst b/doc/source/develop/releasing/check.rst new file mode 100755 index 0000000..c5df2f8 --- /dev/null +++ b/doc/source/develop/releasing/check.rst @@ -0,0 +1,19 @@ +.. _dev_releasing_check: + +Launch the release check pipeline +================================= + +Once you have checked that the code is complete and unit tests were added +for all new code, connect to +`Jenkins `_ +and launch the ctools release check pipeline by clicking on the +``Build with Parameters`` link: + +.. figure:: check.png + :width: 600px + :align: center + + *ctools release check pipeline* + +In case that any errors occur during running the release check pipeline, you +should fix the errors and re-run the pipeline until it terminates with success. diff --git a/doc/source/develop/releasing/index.rst b/doc/source/develop/releasing/index.rst index c6df712..869a5ba 100755 --- a/doc/source/develop/releasing/index.rst +++ b/doc/source/develop/releasing/index.rst @@ -9,7 +9,8 @@ To create a new ctools release you have to go through the following steps: :maxdepth: 1 create - pipeline + check + release tag merge devel diff --git a/doc/source/develop/releasing/pipeline.png b/doc/source/develop/releasing/pipeline.png deleted file mode 100755 index c5875a5..0000000 --- a/doc/source/develop/releasing/pipeline.png +++ /dev/null diff --git a/doc/source/develop/releasing/release.png b/doc/source/develop/releasing/release.png new file mode 100644 index 0000000..f3cbc78 --- /dev/null +++ b/doc/source/develop/releasing/release.png diff --git a/doc/source/develop/releasing/pipeline.rst b/doc/source/develop/releasing/release.rst index 5a2faea..fb9d16e 100755 --- a/doc/source/develop/releasing/pipeline.rst +++ b/doc/source/develop/releasing/release.rst @@ -3,16 +3,17 @@ Launch the release pipeline =========================== -Now you should connect to -`Jenkins `_ -and launch the ctools release pipeline by clicking on the dedicated -button: +Once you have made a final check that all the User documentation is updated +and accurate, connect to +`Jenkins `_ +and launch the ctools release pipeline by clicking on the +``Build with Parameters`` link: -.. figure:: pipeline.png +.. figure:: release.png :width: 600px :align: center *ctools release pipeline* In case that any errors occur during running the release pipeline, you should -fix the errors and rerun the pipeline until it terminates with success. +fix the errors and re-run the pipeline until it terminates with success.