Skip to content

Commit

Permalink
Adds migration docs
Browse files Browse the repository at this point in the history
  • Loading branch information
BenParizek committed Nov 27, 2023
1 parent 2b2a2a5 commit 4d407d8
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions docs/update-guides/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,12 @@ The Sprout plugins are built using the Sprout Framework – a collection of modu

The upgrade guides are organized by plugin and releases are listed by date. Where appropriate, a plugin might link to update notes in another plugin. For example, the Sprout Forms changelog might link to the Sprout Email changelog for a particular update if notable changes have been made to email-specific features.

::: warning Migrations and Craft Commands
Sprout plugins for Craft 4 currently require that you update via the browser to trigger migrations. Running `./craft migrate/all` will not trigger the Sprout module migrations.

Each Sprout module has its own migration track and a single migration might get triggered by one or more modules. Sprout plugins manage the order that migrations need to run and ensure that migrations only run once, but, currently, Craft's CLI commands for migrations do not consider the scenario where a plugin runs migrations that are not using the plugin migration track. We're working on finding a Craft-friendly way to handle this scenario, but for now, to ensure all Sprout migrations run correctly you'll need to run migrations via the Update button in the browser.
:::

## Update Guides

The update guides are primarily for notable changes. Not all plugin versions will appear here in the update guides. See the changelogs for a given plugin for more detailed notes on every release.
Expand Down

0 comments on commit 4d407d8

Please sign in to comment.