www.aleph1.co.uk Git - yaffs-website/blob - web/modules/contrib/media_entity/README.md

   1 # Upgrade path from Media Entity to Media (core)
   2
   3 This version of Media Entity is intended **only** to be used as a bridge to
   4 move to the new "Media" module included in Drupal core (>= 8.4.0). While the
   5 storage of media entities is the same, some aspects of the API have changed.
   6 Because of that, if you have an existing site using Media Entity 1.x, you need
   7 to follow the upgrade path indicated below in order to move to Media in core.
   8
   9 ## Upgrade instructions
  10 1. Backup your code and your database
  11 2. Test that you can successfully roll-back from the backup!
  12 3. Upgrade the codebase with:
  13   - Core: >= **8.4.x**
  14   - Media Entity: **8.x-2.x**
  15   - All media entity providers: **8.x-2.x** (or use patches from #2860796: Plan for
  16   contributed modules with Media Entity API in core). Note that the modules
  17   Media Entity Image and Media Entity Document, if present, don't need to be
  18   updated. Their configs will be updated by the main Media Entity updates.
  19   - All modules that depend on or interact with Media Entity: **8.x-2.x**
  20   - The new contrib module **Media Entity Actions**: **8.x-1.x**
  21   - Note: If your site uses media entities with the "Generic" provider, make
  22   sure you download to your codebase the **Media Entity Generic** module as
  23   well.
  24 4. Clear your caches.
  25 5. (Optional) Check that all requirements for the upgrade are met with
  26   `drush mecu`.
  27   **IMPORTANT**: Please note that if you are running DB updates with Drush 9
  28   (between 9.0.0-alpha1 and 9.0.0-beta7), you are **strongly** encouraged to
  29   use this command prior to running the updates. Drush 9 will not run the
  30   requirements validation and will try to run the updates even if your site has
  31   some of the requisites misconfigured. Executing the updates in that scenario
  32   will likely break your site. This was fixed in Drush 9.0.0-beta8. Drush 8
  33   users don't need to worry about this.
  34 6. Run the DB Updates, either by visiting `/update.php`, or using `drush updb`.
  35 7. Double-check **Media Entity** is uninstalled, and remove it from the
  36   codebase. Remove also **Media Entity Image** / **Document**, if present.
  37 8. Run your automated tests, if any, or manually verify that all media-related
  38   functionality on your site works as expected.
  39
  40 **Known issues concerning the upgrade path:**
  41 - If your existing site relies on the EXIF image metadata handling, please check
  42  https://drupal.org/node/2927481 before proceeding with the upgrade.
  43 - Entity Browser has a 2.x branch that has new features for media in core, for
  44  example the widget that was formerly present in the "Media Entity Image"
  45  module. However, if you intend to upgrade Entity Browser to the 2.x branch, you
  46  should do that only after performing the main Media Entity upgrades. There is
  47  currently a bug preventing the Media Entity upgrade if the Entity Browser 2.x
  48  is present in the codebase.