Category:RoadMap

This page describe what is the Dolibarr release policy/rule and also includes at end list of all past and future releases.

Cette page décrit la politique de release de Dolibarr et présente également a liste des versions futures et à venir.

= Roadmap calendar =

Number of releases per year:
 * Major releases: 2
 * Minor maintenance releases: N (depends on bug reports and criticity)

Dates are (YYYY is current year, YYYY+1 is next year):
 * January YYYY  - Major Release (version A.B.0)
 * March YYYY    - Start Major beta (version A.B+1.0): Freeze. Creation of branch A.B+1. See definition of freeze later.
 * June YYYY     - Major Release (version A.B+1)
 * October YYYY  - Start Major beta (version A.B+2.0): Freeze. Creation of branch A.B+2. See definition of freeze later.
 * January YYYY+1 - Major Release (version A.B+2.0)


 * At any time during year YYYY, maintenance fix releases (version A.*.N) of stable branch (A.*).

Let's take an example :
 * January 2013       - Major Release (version 3.3.0)
 * 15th of March 2013  - Start Major beta (version 3.4.0): Freeze. Creation of branch 3.4.0. See definition of freeze later.
 * In march 2013      - Mainteance release 3.3.1 was released. See definition of maintenance version later.
 * June               - Major Release (version 3.4)
 * 15th of October 2013 - Start Major beta (version 3.5.0): Freeze. Creation of branch 3.5.0. See definition of freeze later.
 * January 2014       - Major Release (version 3.5.0)

= Branch and Source control management = All new features have to been push into develop branch. To follow the release calandar, some other branches with name of major version x.y can be created. According to when we are in the release cycle, thoose branches can be frozen branches or maintenance branches. See here what this means:

Freeze definition
When we make a freeze of code, it means we start the beta period. It does not means that we must not change the code. It means that we can do some thing, and we can't for some other. This is generic definition of a Freeze.

A freeze is done with a goal of a stable version in mind. To start a freeze, a new branch of sources is created, from develop branch, and called x.y branch. A freeze version is the version into branch x.y until version x.y.0 is publicly released. When done it become a maintenance version (see next definition).
 * When a freeze has started, all following things are still allowed into this branch:
 * Any change of code to fix bugs
 * Any change into translation (language files or adding translation key implementation)
 * Any change into data reference (stored into table llx_c_*. For example, update of vat rates, adding countries, ...)
 * Any change to finish works that was started BEFORE the freeze.
 * Any change into theme or looks (change into HTML to match W3C, or CSS changes).
 * Adding call to dol_syslog.
 * Adding a column into a table (+ upgrade script) or index or constraint, but only if it is required to fix a bug.
 * The following things are not allowed:
 * Any change into architecture.
 * Code standardization nor normalization.
 * Adding/removing new external libraries.
 * Adding/removing a table, removing a column.
 * Adding new features. However, adding a component whose code is isolated from rest of the code like a "box file" or "emailing target selector file" or a "script" file into /scripts may be accepted by project leader.

Maintenance definition
When a stable version is released, the branch x.y become a maintenance branch. This means, a lot of things can not be done into this branch anymore. This is generic definition of a maintenance branch.

The maintenance branch keep its name x.y, however, each version will be tagged with name x.y.* (* start to 1 and is increased for each new maintenance version). Only changes to fix "blocking", "annoying" or "security" bugs can be done. Bugs making a new feature not available (when feature was never available) must not necessarily be fixed. It 's just a feature not yet ready into this branch, it will be available with next branch.
 * The following things are allowed:
 * Change code to fix "blocking", "annoying" or "security".
 * Change for translation (language files only or error of key in code, not changing key into language files).
 * Increasing size of a field.
 * Adding a performance index, only if application can't be used without.
 * The following changes are not allowed:
 * Any change into architecture.
 * Code standardization, including renaming variables, translation keys, mutualizing code.
 * Adding/removing new external libraries.
 * Adding/removing a table, adding/removing/changing a column.
 * Adding a foreign key or unique key.
 * Adding new features, even isolated components or scripts.
 * There is an exception: We can add backported code of version x.y+1 into a maintenance branch to prepare transition for developers of external modules, but only if code added is a complete new method or new function, with no other change.

= List of past versions = This Roadmap page is an index of all dedicated pages to RoadMap of each version (past and future).

Cette page Roadmap est un index de toutes les pages RoadMap de chaque version (passée et future).

Esta página Roadmap es un índice de todas las páginas dedicadas al RoadMap de cada versión (pasadas y futuras).