From 83d114013ef17c01233cc3419e7ca3d0c5acdc2f Mon Sep 17 00:00:00 2001 From: bmortier <benoit.mortier@fusiondirectory.org> Date: Fri, 13 Oct 2023 19:11:59 +0000 Subject: [PATCH] Resolve "Adapt the manual to the new rules of branch" --- source/development/workflow-tickets.rst | 4 +-- source/fusiondirectory/coding/sourcecode.rst | 7 ++--- source/fusiondirectory/release/index.rst | 2 +- .../new-fusiondirectory-integrator.rst | 12 +------- .../new-fusiondirectory-orchestrator.rst | 12 +------- .../new-version/new-fusiondirectory-tools.rst | 12 +------- source/new-version/new-fusiondirectory.rst | 28 ++----------------- .../releasing/fusiondirectory-integrator.rst | 8 +++--- .../fusiondirectory-orchestrator.rst | 8 +++--- source/releasing/fusiondirectory-tools.rst | 8 +++--- source/releasing/fusiondirectory.rst | 6 ++-- 11 files changed, 26 insertions(+), 81 deletions(-) diff --git a/source/development/workflow-tickets.rst b/source/development/workflow-tickets.rst index 669a83c..0c5f874 100644 --- a/source/development/workflow-tickets.rst +++ b/source/development/workflow-tickets.rst @@ -60,8 +60,8 @@ if some more info is needed to act on the report - The **need info** label should be added, don’t hesitate to ping the user reporting the bug with **@(useranme)** to ask him to check it out -If the change need to be cherry-picked in a -fixes version -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +If the change need to be merged in a fixed version +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - The **fixes** label is added, when the cherry-pick as been merged we remove the **fixes** and add the **fixes-merged** label diff --git a/source/fusiondirectory/coding/sourcecode.rst b/source/fusiondirectory/coding/sourcecode.rst index e5121e0..b9591f9 100644 --- a/source/fusiondirectory/coding/sourcecode.rst +++ b/source/fusiondirectory/coding/sourcecode.rst @@ -18,12 +18,11 @@ Branches On the Git repository, you will find several existing branches: * `master` contains latest released official code, -* `xxx-fixes` contains the next minor release source code, -* `xxx-dev` contains the next major release source-code, +* `dev` contains the current code in development, -The `xxx-dev` branch is where new features are added. This code is reputed as **non stable**. +The `dev` branch is where new features are added. This code is reputed as **non stable**. -The `xxx-fixes` branches is where bugs are fixed. This code is reputed as *stable*. +The `master` branch is the released code. This code is reputed as *stable*. .. _fhs: diff --git a/source/fusiondirectory/release/index.rst b/source/fusiondirectory/release/index.rst index ab7bb7c..ba0633f 100644 --- a/source/fusiondirectory/release/index.rst +++ b/source/fusiondirectory/release/index.rst @@ -1,7 +1,7 @@ Release Policy ============== -This section explain the release cycle and where contributions, fixes will be merged +This section explain the release cycle and where contributions and new features will be merged .. toctree:: :maxdepth: 2 diff --git a/source/new-version/new-fusiondirectory-integrator.rst b/source/new-version/new-fusiondirectory-integrator.rst index ffb2041..14a2d9c 100644 --- a/source/new-version/new-fusiondirectory-integrator.rst +++ b/source/new-version/new-fusiondirectory-integrator.rst @@ -11,16 +11,6 @@ Create the new milestone - FusionDirectory Integrator version - Start date, date of the milestone creation - - Stop date is start date + 3 month - -Create a new fixes branch from master -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -We need to create a branch - -The branch should be named with the version of the release followed by **-fixes**. - -ex: **1.3** is released the feature branch is **1.3-fixes** - + - Stop date is start date + 6 month .. _milestones : https://gitlab.fusiondirectory.org/groups/fusiondirectory/-/milestones diff --git a/source/new-version/new-fusiondirectory-orchestrator.rst b/source/new-version/new-fusiondirectory-orchestrator.rst index 46f19e8..57ab49f 100644 --- a/source/new-version/new-fusiondirectory-orchestrator.rst +++ b/source/new-version/new-fusiondirectory-orchestrator.rst @@ -11,16 +11,6 @@ Create the new milestone - FusionDirectory Orchestrator version - Start date, date of the milestone creation - - Stop date is start date + 3 month - -Create a new fixes branch from master -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -We need to create a branch - -The branch should be named with the version of the release followed by **-fixes**. - -ex: **1.3** is released the feature branch is **1.3-fixes** - + - Stop date is start date + 6 month .. _milestones : https://gitlab.fusiondirectory.org/groups/fusiondirectory/-/milestones diff --git a/source/new-version/new-fusiondirectory-tools.rst b/source/new-version/new-fusiondirectory-tools.rst index 82b0a9d..cf5cb10 100644 --- a/source/new-version/new-fusiondirectory-tools.rst +++ b/source/new-version/new-fusiondirectory-tools.rst @@ -11,16 +11,6 @@ Create the new milestone - FusionDirectory Orchestrator version - Start date, date of the milestone creation - - Stop date is start date + 3 month - -Create a new fixes branch from master -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -We need to create a branch - -The branch should be named with the version of the release followed by **-fixes**. - -ex: **1.3** is released the feature branch is **1.3-fixes** - + - Stop date is start date + 6 month .. _milestones : https://gitlab.fusiondirectory.org/groups/fusiondirectory/-/milestones diff --git a/source/new-version/new-fusiondirectory.rst b/source/new-version/new-fusiondirectory.rst index d97c51b..0dae1e8 100644 --- a/source/new-version/new-fusiondirectory.rst +++ b/source/new-version/new-fusiondirectory.rst @@ -2,38 +2,14 @@ Creating a new version of FusionDirectory ========================================= - Create the new milestone -- Create the new branchs from master -- Update include/variables_common.inc Create the new milestone ^^^^^^^^^^^^^^^^^^^^^^^^ -- got to FusionDirectory `milestones`_ and create the new milestone +- got to FusionDirectory `milestones`_ and create the new milestone, version is the version number - FusionDirectory version - Start date, date of the milestone creation - - Stop date is start date + 3 month - -Create a new fixes branch from master -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -We need to create a branch for fusiondirectory and fusiondirectory-plugins - -The branch should be named with the version of the release followed by **-fixes**. - -ex: **1.3** is released the feature branch is **1.3-fixes** - -Increment FusionDirectory version -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Only if you create a new feature branch for FusionDirectory - -open include/variables_common.inc - -Change the version number in : - -.. code:: php - - define ("FD_VERSION", "1.3-fixes"); + - Stop date is start date + 6 month .. _milestones : https://gitlab.fusiondirectory.org/groups/fusiondirectory/-/milestones diff --git a/source/releasing/fusiondirectory-integrator.rst b/source/releasing/fusiondirectory-integrator.rst index 818e3d7..3d94449 100644 --- a/source/releasing/fusiondirectory-integrator.rst +++ b/source/releasing/fusiondirectory-integrator.rst @@ -5,9 +5,9 @@ How to release a FusionDirectory Integrator Version - Updates the Changelog.md file - Write the upgrade documentation - Update the UPGRADE.md -- Merge the fixes branch into master +- Merge the branch into master -All those operations have to be made onto the 1.x-fixes branch each one +All those operations have to be made onto a branch each one of them inside a ticket with the label ~release and with a **MR** Update the AUTHORS file @@ -57,8 +57,8 @@ you can run for example directly in the user-manual source to generate the content to copy/paste at the end of UPGRADE.MD -Merge the fixes branch into master -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +Merge the branch into master +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Only a gitlab master account user can do the merge on the master branch diff --git a/source/releasing/fusiondirectory-orchestrator.rst b/source/releasing/fusiondirectory-orchestrator.rst index 827578e..5563909 100644 --- a/source/releasing/fusiondirectory-orchestrator.rst +++ b/source/releasing/fusiondirectory-orchestrator.rst @@ -5,9 +5,9 @@ How to release a FusionDirectory Orchestrator Version - Updates the Changelog.md - Write the upgrade documentation - Update the UPGRADE.md -- Merge the fixes branch into master +- Merge the branch into master -All those operations have to be made onto the 1.x-fixes branch each one +All those operations have to be made onto a branch each one of them inside a ticket with the label ~release and with a **MR** Update the AUTHORS file @@ -57,8 +57,8 @@ you can run for example directly in the user-manual source to generate the content to copy/paste at the end of UPGRADE.MD -Merge the fixes branch into master -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +Merge the branch into master +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Only a gitlab master account user can do the merge on the master branch diff --git a/source/releasing/fusiondirectory-tools.rst b/source/releasing/fusiondirectory-tools.rst index 971259a..48565bc 100644 --- a/source/releasing/fusiondirectory-tools.rst +++ b/source/releasing/fusiondirectory-tools.rst @@ -5,9 +5,9 @@ How to release a FusionDirectory Tools Version - Updates the Changelog.md - Write the upgrade documentation - Update the UPGRADE.md -- Merge the fixes branch into master +- Merge the branch into master -All those operations have to be made onto the 1.x-fixes branch each one +All those operations have to be made onto a branch each one of them inside a ticket with the label ~release and with a **MR** Update the AUTHORS file @@ -57,8 +57,8 @@ you can run for example directly in the user-manual source to generate the content to copy/paste at the end of UPGRADE.MD -Merge the fixes branch into master -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +Merge the branch into master +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Only a gitlab master account user can do the merge on the master branch diff --git a/source/releasing/fusiondirectory.rst b/source/releasing/fusiondirectory.rst index 0efaa34..f460e3f 100644 --- a/source/releasing/fusiondirectory.rst +++ b/source/releasing/fusiondirectory.rst @@ -12,7 +12,7 @@ How to release a FusionDirectory Version - Merge the branch into master for fusiondirectory and fusiondirectory plugins -All those operations have to be made onto the 1.x-fixes branch each one +All those operations have to be made onto a branch each one of them inside a ticket with the label ~release and with a **MR** Updates the locales @@ -84,8 +84,8 @@ you can run for example directly in the user-manual source to generate the content to copy/paste at the end of UPGRADE.MD -Merge the fixes branch into master -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +Merge the branch into master +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Only a gitlab master account user can do the merge on the master branch -- GitLab