Skip to content
Snippets Groups Projects
Commit e84dfd27 authored by totten's avatar totten
Browse files

#9 - Document minimum-stability

This option was often set permissively in D8 project-templates - and it's
often set restrictively in D9 project-templates.

Adding the step generally shouldn't change anything for D8 admins -- and for
D9 admins it enables installation to proceed.
parent 7d17e94f
No related branches found
No related tags found
1 merge request!26Make D9 support visible
......@@ -66,6 +66,7 @@ If `composer` is properly installed, then these example commands will add CiviCR
```
cd /var/www/drupal.example.org
composer config extra.enable-patching true
composer config minimum-stability dev
composer require civicrm/civicrm-asset-plugin:'~1.1'
composer require civicrm/civicrm-{core,packages,drupal-8}:'~5.35'
```
......@@ -81,6 +82,21 @@ If you'd like more details to understand these commands or common errors, then p
This is possible with the popular [cweagans/composer-patches](https://github.com/cweagans/composer-patches)
plugin. However, you must [opt-in to enable it](https://github.com/cweagans/composer-patches#allowing-patches-to-be-applied-from-dependencies).
??? info "More detail: Package stability"
For any package in `composer`, there may be several available versions. Some have an official, well-defined name
or number (e.g. `v1.2.3`), and these are called "stable" versions. Other versions have an interim name or number
(e.g. `v1.2.alpha1` or `dev-master`) indicating that additional testing is appropriate.
As a general rule, a new `composer` deployment will (and should) only use "stable" versions. CiviCRM, too, is
generally built around "stable" dependencies. However, in some exceptional cases, CiviCRM requires an interim
release of some libraries.
`composer.json` has two options which affect this: [minimum-stability](https://getcomposer.org/doc/04-schema.md#minimum-stability) sets an
absolute baseline, and [prefer-stable](https://getcomposer.org/doc/04-schema.md#prefer-stable) expresses a general preference.
Setting `minimum-stability` to `dev` enables to installation to proceed when there are exceptional cases. Setting
`prefer-stable` to `true` means that `composer` will use stable releases whenever it can.
??? info "More detail: Compilation tasks"
When you first install or upgrade to CiviCRM 5.31+, `composer` will prompt for permission to run CiviCRM compilation tasks. We recommend that you select `[a]lways`.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment