Add upgrade docs

kaliop-uk · Aug 3, 2016 · a3ea4f3 · a3ea4f3
1 parent c6720fc
commit a3ea4f3
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -96,6 +96,12 @@ To apply all available migrations run the migrate command in your eZ Publish 5 r
 NB: if you just executed the above command and got an error message because the migration definition file that you had
 just generated is invalid, do not worry - that is by design. Head on to the next paragraph...
 
+#### Applying a single migration file
+
+To apply a single migration run the migrate command passing it the path to its definition, as follows:
+
+    php ezpublish/console kaliop:migration:migrate --path=src/MyNamespace/MyBundle/MigrationsVersions/20160803193400_a_migration.yml
+
 ### Editing migration files
 
 So far so good, but what kind of actions can be actually done using a migration?

diff --git a/Resources/doc/Upgrading/1.x_to_2.0.md b/Resources/doc/Upgrading/1.x_to_2.0.md
@@ -0,0 +1,13 @@
+Upgrade instructions for upgrading from version 1.x to 2.0
+==========================================================
+
+1. Upgrade the Migration Bundle to the 2.0 version using composer
+
+2. before you try to execute any further migration, run the following command
+
+        php ezpublish/console kaliop:migration:migrate --path=vendor/kaliop/ezmigrationbundle/MigrationVersions/20100101000200_MigrateV1ToV2.php
+
+    This will populate the v2 migrations table in the db with information from the v1 database table.
+
+    The v1 database table will be left in the database; feel free to drop it when you feel safe enough that you will
+    not need to roll back the Migration Bundle to its version 1.