From a1cf3ee5a9c81a7ac0cca55d730f21bf2a940ecb Mon Sep 17 00:00:00 2001 From: Andreas Hennings Date: Tue, 14 Dec 2021 00:36:57 +0100 Subject: [PATCH] Issue #141: Update README.md: Upgrade path is somewhat supported. --- README.md | 21 ++++++++++++++------- 1 file changed, 14 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 898c8269..0f4d515c 100644 --- a/README.md +++ b/README.md @@ -14,16 +14,23 @@ With `1.0-alpha17`, the SPARQL storage has been [split out, as a standalone module](https://github.com/ec-europa/rdf_entity/issues/17). Moving services from one module to the other is impossible with the actual Drupal core. See the [related Drupal core issue](https://www.drupal.org/project/drupal/issues/2863986) -for details. As the -module is in alpha, we're not providing any update path but we recommend to -follow the next steps in order to update a server in production: +for details. + +As this module is in alpha, we would normally not provide an upgrade path. +However, we have since become aware of a number of websites that we have an interest in supporting, that use `rdf_entity`, and that need a reliable upgrade path. + +We recommend the following steps in order to update a server in production: 1. The update process is split in two consecutive deployments. 1. Install an empty version of the `sparql_entity_storage` module: ``` $ composer require drupal/sparql_entity_storage:dev-empty-module ``` -1. Enable the module. -1. Deploy to production. -1. Require `drupal/rdf_entity` with the new `1.0-alpha17` version and -perform a second deployment. +1. Enable the `sparql_entity_storage` module, export to config. +1. Deploy the changes to production. + (A typical deployment operation will include `drush cr`, `drush updb -y` and `drush cim -y`.) +1. Require `drupal/rdf_entity:^1.0-alpha17`, and perform a second deployment. + +Please open an issue if any problems occur during this update process. + +If the module is / was used for [RDF SKOS](https://github.com/openeuropa/rdf_skos), please follow the more relevant instructions over there.