about summary refs log tree commit diff
path: root/lib/generators/post_deployment_migration/USAGE
diff options
context:
space:
mode:
Diffstat (limited to 'lib/generators/post_deployment_migration/USAGE')
-rw-r--r--lib/generators/post_deployment_migration/USAGE10
1 files changed, 10 insertions, 0 deletions
diff --git a/lib/generators/post_deployment_migration/USAGE b/lib/generators/post_deployment_migration/USAGE
new file mode 100644
index 000000000..57f3c6aa1
--- /dev/null
+++ b/lib/generators/post_deployment_migration/USAGE
@@ -0,0 +1,10 @@
+Description:
+    Generate a Rails migration in the db/post_migrate/ dir.
+
+    Interacts with the post_deployment_migrations initializer.
+
+Example:
+    bin/rails generate post_deployment_migration IsolateChanges
+
+    Creates a migration in db/post_migrate/<timestamp>_isolate_changes.rb
+    which will have `disable_ddl_transaction!` and a `change` method included.