Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit abf2137

Browse files
authored
Merge pull request #32 from kpodemski/adr-module-versions
0020 - Module versioning convention when min compat with the core is updated
2 parents 23564aa + a1958ad commit abf2137

1 file changed

Lines changed: 30 additions & 0 deletions

File tree

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# 20. Module versioning convention when minimum compatibilty with the core is updated
2+
3+
Date: 2023-02-21
4+
5+
## Status
6+
7+
In discussion
8+
9+
## Context
10+
11+
When working on PrestaShop open source module, we release new versions.
12+
13+
Sometimes a new version of a module requires to bump the required minimum PrestaShop Core versions, for example
14+
- `module_a` can run with PrestaShop 1.7.1 to 1.7.8
15+
- later, with a new version of `module_a`, it can run with minimum PrestaShop 8.0
16+
17+
To this day, it is not clear whether these two scenarios require upgrading major or minor versions of the module.
18+
19+
**The topic of this ADR is "what version bump should we apply when PrestaShop Core minimum version is bumped?"**
20+
21+
It is important to understand that **bumping required minimum PrestaShop Core version means dropping some compatibility** for the module. The module's previous version could run with some PS versions, but the new version cannot. It can be considered as a BC Break, this is why we should agree on bumping major version of the module.
22+
23+
[Example with ps_searchbar](https://github.com/PrestaShop/ps_searchbar/pull/24)
24+
25+
### Consequences
26+
27+
Every time we change minimum compatible version of PrestaShop Core for a module, we need to bump module major version. Example:
28+
29+
IF we change minimum compatible PrestaShop Core v ersion (ex: PS 1.7.6.2 => 1.7.7.0, PS 1.7.4 -> 8.0)
30+
THEN the module version must be bumped to the next major version (ex: ps_searchbar 2.0.1 => 3.0.0).

0 commit comments

Comments
 (0)