Skip to content

Commit 0445e04

Browse files
colinmollenhourfballiano
authored andcommitted
Updated README.md to reflect new RFC 0002 - Release Schedule (#3139)
1 parent cbad8d8 commit 0445e04

File tree

1 file changed

+33
-8
lines changed

1 file changed

+33
-8
lines changed

README.md

+33-8
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,8 @@ level of backwards compatibility to the official releases.
2020

2121
## Table of contents
2222

23+
- [Releases and Versioning](#releases-and-versioning)
24+
- [Currently Maintained Versions](#currently-maintained-versions)
2325
- [Requirements](#requirements)
2426
- [Installation](#installation)
2527
- [Manual Install](#manual-install)
@@ -28,22 +30,42 @@ level of backwards compatibility to the official releases.
2830
- [Secure your installation](#secure-your-installation)
2931
- [Apache .htaccess](#apache-htaccess)
3032
- [Nginx](#nginx)
33+
- [Magento 1 Compatibility](#magento-1-compatibility)
3134
- [Changes](#changes)
3235
- [Between Magento 1.9.4.5 and OpenMage 19.x](#between-magento-1945-and-openmage-19x)
33-
- [Between OpenMage 19.4.18 / 20.0.16 and 19.4.19 / 20.0.17](#between-openmage-19418--20016-and-19419--20017)
3436
- [Since OpenMage 19.5.0 / 20.1.0](#since-openmage-1950--2010)
3537
- [New Config Options](#new-config-options)
3638
- [New Events](#new-events)
3739
- [Changes to SOAP/WSDL](#changes-to-soapwsdl)
3840
- [Development Environment with ddev](#development-environment-with-ddev)
39-
- [Development with PHP 8.1+](#development-with-php-81)
4041
- [PhpStorm Factory Helper](#phpstorm-factory-helper)
41-
- [Versioning](#versioning)
4242
- [Public Communication](#public-communication)
4343
- [Maintainers](#maintainers)
4444
- [License](#license)
4545
- [Contributors](#contributors-)
4646

47+
## Releases and Versioning
48+
49+
This project more strictly adheres to [Semantic Versioning](http://semver.org/) compared to the original Magento version numbering system where the "1"
50+
was essentially a fixed number. See the [Terminology](https://github.com/OpenMage/rfcs/blob/main/accepted/0002-release-schedule.md#terminology)
51+
section of [RFC 0002 - Release Schedule](https://github.com/OpenMage/rfcs/blob/main/accepted/0002-release-schedule.md) for more information on how the terms MAJOR, MINOR and PATCH are defined and applied.
52+
53+
The OpenMage team and community maintains OpenMage LTS versions as follows:
54+
55+
- The latest MAJOR.MINOR version always receives PATCH updates.
56+
- The latest MAJOR version always receives MINOR updates.
57+
- The latest MAJOR.MINOR branch for each MAJOR version receives PATCH updates for at least 2 years from the time of inception of the initial MAJOR version release.
58+
59+
In a nutshell:
60+
61+
- If you want to stay on the cutting edge with the latest improvements use the latest MAJOR version.
62+
- If you want maximum backwards compatibility and minimal upgrade hassle use the next-latest MAJOR version so that you can still receive important security/stability/regression fixes.
63+
64+
### Currently Maintained Versions
65+
66+
- 20.x is the latest MAJOR version and will receive PATCH updates until 2 years after the date that 21.x is released.
67+
- 19.4.x will receive PATCH updates until April 4, 2025.
68+
4769
## Requirements
4870

4971
- PHP 7.4+ (PHP 8.0 is supported, PHP 8.1 supported but some warnings may be shown/logged, PHP 8.2 is usable but still being tested)
@@ -166,6 +188,14 @@ RewriteRule ^api/rest api.php?type=rest [QSA,L]
166188
rewrite ^/api/(\w+).*$ /api.php?type=$1 last;`
167189
```
168190

191+
## Magento 1 Compatibility
192+
193+
OpenMage LTS 19.4.0 is the first tagged version using the OpenMage LTS version naming system and all 19.x versions are mostly backward-compatible
194+
with Magento 1.9.4.x.
195+
196+
OpenMage LTS 20.x and later have more changes that may not be 100% backward-compatible, but minimizing migration and upgrade hassle for users is always
197+
considered an important goal and factors heavily into the changes that are accepted even when accepting changes for "MAJOR" releases, described in [Releases and Versioning](#releases-and-versioning) above.
198+
169199
## Changes
170200

171201
Most important changes will be listed here, all other changes since `19.4.0` can be found in
@@ -319,11 +349,6 @@ You can add additional meta files in this directory to cover your own project fi
319349
[PhpStorm advanced metadata](https://www.jetbrains.com/help/phpstorm/ide-advanced-metadata.html)
320350
for more information.
321351

322-
## Versioning
323-
324-
Though Magento does __not__ follow [Semantic Versioning](http://semver.org/) we aim to provide a workable system for
325-
dependency definition.
326-
327352
## Public Communication
328353

329354
* [Discord](https://discord.gg/EV8aNbU) (maintained by Flyingmana)

0 commit comments

Comments
 (0)