Add checklists part; add checlist for new major release process

glpi-project · Oct 21, 2016 · 4f6d602 · 4f6d602
1 parent 13278c5
commit 4f6d602
Show file tree

Hide file tree

Showing 4 changed files with 33 additions and 3 deletions.
diff --git a/source/checklists/index.rst b/source/checklists/index.rst
@@ -0,0 +1,10 @@
+Checklists
+==========
+
+Some really usefull checklists, for development, releases, and so on!
+
+.. toctree::
+   :maxdepth: 2
+
+   reviewprocess
+   preparenextmajor
diff --git a/source/checklists/preparenextmajor.rst b/source/checklists/preparenextmajor.rst
@@ -0,0 +1,20 @@
+Prepare next major release
+--------------------------
+
+Once a major release has been finished, it's time to think about the next one!
+
+You'll have to remember a few steps in order to get that working well:
+
+* bump version in ``config/define.php``
+* create SQL empty script (copying last one) in ``install/mysql/glpi-{version}-empty.sql``
+* change empty SQL file calls in ``inc/toolbox.class.php`` (look for the ``$DB->runFile`` call)
+* create a PHP migration script copying provided template ``install/update_xx_xy.tpl.php``
+
+  * change its main comment to reflect reality
+  * change method name
+  * change version in ``displayTitle`` and ``setVersion`` calls
+
+* add the new ``case`` in ``install/update.php`` and ``tools/cliupdate.php``; that will include your new PHP migration script and then call the function defined in it
+* change the ``include`` and the function called in the ``--force`` option part of the ``tools/cliupdate.php`` script
+
+That's all, folks!
diff --git a/source/reviewprocess.rst → source/checklists/reviewprocess.rst b/source/reviewprocess.rst → source/checklists/reviewprocess.rst
@@ -1,5 +1,5 @@
 Review process
-==============
+--------------
 
 Here is the process you must follow when you are reviewing a PR.
 
@@ -10,7 +10,7 @@ Here is the process you must follow when you are reviewing a PR.
 
 2. Check if unit tests are not failing,
 3. Check if coding standards checks are not failing,
-4. Review the code itself. It must follow :doc:`GLPi's coding standards <codingstandards>`,
+4. Review the code itself. It must follow :doc:`GLPi's coding standards <../codingstandards>`,
 5. Using the Github review process, approve, request changes or just comment the PR,
 
   * If some new methods are added, or if the request made important changes in the code, you should ask the developer to write some more unit tests

diff --git a/source/index.rst b/source/index.rst
@@ -16,5 +16,5 @@ GLPi Developer Documentation
    sourcecode
    codingstandards
    devapi/index
-   reviewprocess
+   checklists/index
    plugins