From 08cf3fa31d141df3b9b0c619b2fdd29b32147c4b Mon Sep 17 00:00:00 2001 From: Jürgen Knödlseder Date: Fri, 24 May 2019 14:04:09 +0200 Subject: [PATCH] Update developer documentation --- doc/source/develop/releasing/check.png | Bin 0 -> 362606 bytes doc/source/develop/releasing/check.rst | 19 +++++++++++++++++++ doc/source/develop/releasing/index.rst | 3 ++- doc/source/develop/releasing/pipeline.png | Bin 486356 -> 0 bytes doc/source/develop/releasing/pipeline.rst | 18 ------------------ doc/source/develop/releasing/release.png | Bin 0 -> 430623 bytes doc/source/develop/releasing/release.rst | 19 +++++++++++++++++++ 7 files changed, 40 insertions(+), 19 deletions(-) create mode 100644 doc/source/develop/releasing/check.png create mode 100755 doc/source/develop/releasing/check.rst delete mode 100755 doc/source/develop/releasing/pipeline.png delete mode 100755 doc/source/develop/releasing/pipeline.rst create mode 100644 doc/source/develop/releasing/release.png create mode 100755 doc/source/develop/releasing/release.rst diff --git a/doc/source/develop/releasing/check.png b/doc/source/develop/releasing/check.png new file mode 100644 index 0000000..fb1ab8b Binary files /dev/null and b/doc/source/develop/releasing/check.png differ 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 Binary files a/doc/source/develop/releasing/pipeline.png and /dev/null differ diff --git a/doc/source/develop/releasing/pipeline.rst b/doc/source/develop/releasing/pipeline.rst deleted file mode 100755 index 5a2faea..0000000 --- a/doc/source/develop/releasing/pipeline.rst +++ /dev/null @@ -1,18 +0,0 @@ -.. _dev_releasing_pipeline: - -Launch the release pipeline -=========================== - -Now you should connect to -`Jenkins `_ -and launch the ctools release pipeline by clicking on the dedicated -button: - -.. figure:: pipeline.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. diff --git a/doc/source/develop/releasing/release.png b/doc/source/develop/releasing/release.png new file mode 100644 index 0000000..f3cbc78 Binary files /dev/null and b/doc/source/develop/releasing/release.png differ diff --git a/doc/source/develop/releasing/release.rst b/doc/source/develop/releasing/release.rst new file mode 100755 index 0000000..fb9d16e --- /dev/null +++ b/doc/source/develop/releasing/release.rst @@ -0,0 +1,19 @@ +.. _dev_releasing_pipeline: + +Launch the release pipeline +=========================== + +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:: 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 re-run the pipeline until it terminates with success. -- libgit2 0.21.4