From 611e7efa1a00fc3643215f83a2ab1140ec9a417a Mon Sep 17 00:00:00 2001 From: Andreas Hennings Date: Thu, 21 Apr 2022 23:29:13 +0200 Subject: [PATCH] OEL-1357: How to require alpha version. Remove when stable is released. --- README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/README.md b/README.md index 84c67f0d2..0ba42f42e 100644 --- a/README.md +++ b/README.md @@ -53,12 +53,32 @@ Add this manually in composer.json, or combine with existing entries: } ``` +If your project is still in development, you may modify composer.json to allow alpha versions, while this package and some of its dependencies are still in their `alpha` phase. + +Review this again when the site goes into production. + +``` + "minimum-stability": "alpha", +``` + Require with composer: ```bash composer require openeuropa/oe_whitelabel ``` +If composer.json does not allow alpha versions, a version string needs to be appended to the package name in the require command, and other dependencies with alpha versions also need to be required with explicit version strings. The version string could be `:^1.0@alpha`, or a specific version like `:^1.0.0-alpha7`. + +```bash +composer require openeuropa/oe_whitelabel:^1.0@alpha openeuropa/oe_bootstrap_theme:^1.0@alpha +``` + +Review the installed package versions. Make sure that oe_whitelabel and oe_bootstrap theme are using 1.x or higher. + +```bash +composer show -i | grep oe_ +``` + ### Enable and configure Enable required and optional submodules: