Skip to content

Commit 1e64210

Browse files
fballianosreichel
andauthored
Added notes about composer library/modules to README (for 19.5.x and 20.1.x) (#2851)
* Added notes about 19.5 and 20.1 in README * Removed note for mcrypt It was removed from PHP7.2 * Moved versioning section * Updated requirements * Updated badges * No need for the "unofficial" word * Added note about gpatch * Typo Co-authored-by: Sven Reichel <github-sr@hotmail.com>
1 parent e80edcb commit 1e64210

File tree

1 file changed

+35
-24
lines changed

1 file changed

+35
-24
lines changed

README.md

Lines changed: 35 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,11 @@
11
<p align="center">
22
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
3-
<a href="#contributors-"><img src="https://img.shields.io/badge/all_contributors-146-orange.svg?style=flat-square" alt="All Contributors"></a>
3+
<a href="#contributors-"><img src="https://img.shields.io/badge/all_contributors-146-orange.svg" alt="All Contributors"></a>
44
<!-- ALL-CONTRIBUTORS-BADGE:END -->
55
<a href="https://packagist.org/packages/openmage/magento-lts"><img src="https://poser.pugx.org/openmage/magento-lts/d/total.svg" alt="Total Downloads"></a>
66
<a href="https://packagist.org/packages/openmage/magento-lts"><img src="https://poser.pugx.org/openmage/magento-lts/license.svg" alt="License"></a>
7-
<br />
87
<a href="https://github.com/openmage/magento-lts/actions/workflows/security-php.yml"><img src="https://github.com/openmage/magento-lts/actions/workflows/security-php.yml/badge.svg" alt="PHP Security workflow Badge" /></a>
9-
<a href="https://github.com/openmage/magento-lts/actions/workflows/composer.yml"><img src="https://github.com/openmage/magento-lts/actions/workflows/composer.yml/badge.svg" alt="Composer workflow Badge" /></a>
10-
<a href="https://github.com/openmage/magento-lts/actions/workflows/syntax-php.yml"><img src="https://github.com/openmage/magento-lts/actions/workflows/syntax-php.yml/badge.svg" alt="PHP Syntax Check workflow badge" /></a>
11-
<a href="https://github.com/openmage/magento-lts/actions/workflows/syntax-xml.yml"><img src="https://github.com/openmage/magento-lts/actions/workflows/syntax-xml.yml/badge.svg" alt="XML Syntax Check workflow badge" /></a>
12-
<a href="https://github.com/openmage/magento-lts/actions/workflows/phpcs.yml"><img src="https://github.com/openmage/magento-lts/actions/workflows/phpcs.yml/badge.svg" alt="PHPCS workflow badge" /></a>
13-
<a href="https://github.com/openmage/magento-lts/actions/workflows/php-cs-fixer.yml"><img src="https://github.com/openmage/magento-lts/actions/workflows/php-cs-fixer.yml/badge.svg" alt="PHP-CS-Fixer workflow badge" /></a>
14-
<a href="https://github.com/openmage/magento-lts/actions/workflows/phpstan.yml"><img src="https://github.com/openmage/magento-lts/actions/workflows/phpstan.yml/badge.svg" alt="PHPStan workflow badge" /></a>
15-
<a href="https://github.com/openmage/magento-lts/actions/workflows/sonar.yml"><img src="https://github.com/openmage/magento-lts/actions/workflows/sonar.yml/badge.svg" alt="Sonar workflow badge" /></a>
16-
<a href="https://github.com/openmage/magento-lts/actions/workflows/phpunit.yml"><img src="https://github.com/openmage/magento-lts/actions/workflows/phpunit.yml/badge.svg" alt="PHPUnit workflow badge" /></a>
8+
<a href="https://github.com/OpenMage/magento-lts/actions/workflows/workflow.yml"><img src="https://github.com/OpenMage/magento-lts/actions/workflows/workflow.yml/badge.svg" alt="CI workflow Badge" /></a>
179
</p>
1810

1911
# Magento - Long Term Support
@@ -22,21 +14,17 @@ This repository is the home of an **unofficial** community-driven project. It's
2214
to the Magento CE official releases which integrates improvements directly from the community while maintaining a high
2315
level of backwards compatibility to the official releases.
2416

25-
**Pull requests with unofficial bug fixes and security patches from the community are encouraged and welcome!**
26-
27-
### Versioning
28-
29-
Though Magento does __not__ follow [Semantic Versioning](http://semver.org/) we aim to provide a workable system for
30-
dependency definition. Each Magento `1.<minor>.<revision>` release will get its own branch (named `1.<minor>.<revision>.x`)
31-
that will be independently maintained with upstream patches and community bug fixes for as long as it makes sense
32-
to do so (based on available resources). For example, Magento version `1.9.4.5` was merged into the `1.9.4.x` branch.
17+
**Pull requests with bug fixes and security patches from the community are encouraged and welcome!**
3318

3419
## Requirements
3520

36-
- PHP 7.3+ (PHP 8.0 is supported)<br/>
37-
`mcrypt` extension needs to be disabled to fallback on `mcryptcompat` and `phpseclib`.
21+
- PHP 7.3+ (PHP 8.0 is supported)
3822
- MySQL 5.6+ (8.0+ recommended) or MariaDB
3923

24+
25+
- PHP extension `intl` <small>since 1.9.4.19 & 20.0.17</small>
26+
- Command `patch` 2.7+ (or `gpatch` on MacOS/HomeBrew) <small>since 1.9.5.0 & 20.1.0</small>
27+
4028
__Please be aware that although OpenMage is compatible that one or more extensions may not be.__
4129

4230
### Optional
@@ -50,7 +38,7 @@ __Please be aware that although OpenMage is compatible that one or more extensio
5038
Download the latest archive and extract it, clone the repo, or add a composer dependency to your existing project like so:
5139

5240
```bash
53-
composer require "openmage/magento-lts":"^19.4.0"
41+
composer require "openmage/magento-lts":"^19.5.0"
5442
```
5543

5644
To get the latest changes use:
@@ -116,9 +104,8 @@ Most important changes will be listed here, all other changes since `19.4.0` can
116104
- `Mage_Xmlconnect`
117105
- `Phoenix_Moneybookers`
118106

119-
120-
_If you rely on that modules you can reinstall them with composer:_
121-
- `Mage_PageCache`: `composer require openmage/bc-mage-pagecache:dev-master`
107+
_If you rely on those modules you can reinstall them with composer:_
108+
- `Mage_PageCache`: `composer require openmage/module-mage-pagecache`
122109

123110
### Between OpenMage 19.4.18 / 20.0.16 and 19.4.19 / 20.0.17
124111

@@ -140,6 +127,23 @@ Do not use 20.x.x if you need IE support.
140127

141128
For full list of changes, you can [compare tags](https://github.com/OpenMage/magento-lts/compare/1.9.4.x...20.0).
142129

130+
### Since OpenMage 19.5.0 / 20.1.0
131+
132+
Most of the 3rd party libraries/modules that were bundled in our repository were removed and migrated to composer dependencies.
133+
This allows for better maintenance and upgradability.
134+
135+
Specifically:
136+
- phpseclib, mcrypt_compat, Cm_RedisSession, Cm_Cache_Backend_Redis, Pelago_Emogrifier (#2411)
137+
- Zend Framework 1 (#2827)
138+
139+
If your project uses OpenMage through composer then all dependencies will be managed automatically.
140+
If you just extracted the release zip/tarball in your project's main folder then be sure to:
141+
- remove the old copy of aforementioned libraries from your project, you can do that with this command:
142+
`rm -rf lib/Cm lib/Credis lib/mcryptcompat lib/Pelago lib/phpseclib lib/Zend`
143+
- download the new release zip file that is named `openmage-VERSIONNUMBER.zip`, this one is built to contain the `vendor`
144+
folder generated by composer, with all the dependencies in it
145+
- extract the zip file in your project's repository as you always did
146+
143147
### New Config Options
144148

145149
- `admin/design/use_legacy_theme`
@@ -221,6 +225,13 @@ You can add additional meta files in this directory to cover your own project fi
221225
[PhpStorm advanced metadata](https://www.jetbrains.com/help/phpstorm/ide-advanced-metadata.html)
222226
for more information.
223227

228+
## Versioning
229+
230+
Though Magento does __not__ follow [Semantic Versioning](http://semver.org/) we aim to provide a workable system for
231+
dependency definition. Each Magento `1.<minor>.<revision>` release will get its own branch (named `1.<minor>.<revision>.x`)
232+
that will be independently maintained with upstream patches and community bug fixes for as long as it makes sense
233+
to do so (based on available resources). For example, Magento version `1.9.4.5` was merged into the `1.9.4.x` branch.
234+
224235
## Public Communication
225236

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

0 commit comments

Comments
 (0)