summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAchilleas Pipinellis <axil@gitlab.com>2019-09-04 15:19:40 +0000
committerAchilleas Pipinellis <axil@gitlab.com>2019-09-04 15:19:40 +0000
commit98c79081cec42e071173757a80300b74a0f26976 (patch)
tree6576a660747048f404f9504b4373c9b080fb7725
parenta2fe68c010b68537d203b3c8f1c249e3feb0cf8a (diff)
parentb1fd8466ebcde2c366a75e236b947c1378255ae7 (diff)
downloadgitlab-ce-66922.tar.gz
Merge branch 'docs-fixes-scheduling-on-background-migrations' into 'master'66922
Cleans up "Scheduling" section on Background Migrations See merge request gitlab-org/gitlab-ce!32557
-rw-r--r--doc/development/background_migrations.md15
1 files changed, 9 insertions, 6 deletions
diff --git a/doc/development/background_migrations.md b/doc/development/background_migrations.md
index 3fd95537eaa..a456bbc781f 100644
--- a/doc/development/background_migrations.md
+++ b/doc/development/background_migrations.md
@@ -61,8 +61,8 @@ migration classes must be defined in the namespace
## Scheduling
-Scheduling a migration can be done in either a regular migration or a
-post-deployment migration. To do so, simply use the following code while
+Scheduling a background migration should be done in a post-deployment migration.
+To do so, simply use the following code while
replacing the class name and arguments with whatever values are necessary for
your migration:
@@ -283,10 +283,13 @@ the `services.properties` column.
## Testing
-It is required to write tests for background migrations' scheduling migration
-(either a regular migration or a post deployment migration), background
-migration itself and a cleanup migration. You can use the `:migration` RSpec
-tag when testing a regular / post deployment migration.
+It is required to write tests for:
+
+- The background migrations' scheduling migration.
+- The background migration itself.
+- A cleanup migration.
+
+You can use the `:migration` RSpec tag when testing the migrations.
See [README][migrations-readme].
When you do that, keep in mind that `before` and `after` RSpec hooks are going