From 618ce14842aaf40aeaebf9eda910d2dba9aef8c8 Mon Sep 17 00:00:00 2001 From: Ben Thorner Date: Wed, 5 May 2021 14:27:05 +0100 Subject: [PATCH] Rewrite migration README This clarifies how we generate migration filenames, and points to the official docs and help commands, instead of repeating them. --- migrations/README.md | 10 +++------- 1 file changed, 3 insertions(+), 7 deletions(-) diff --git a/migrations/README.md b/migrations/README.md index b2977a1cf..478b186b6 100644 --- a/migrations/README.md +++ b/migrations/README.md @@ -1,9 +1,5 @@ -Generic single-database configuration. +See https://flask-alembic.readthedocs.io/en/stable/. -flask db migrate to generate migration script. +You can run `flask db` for a list of the available commands. -flask db upgrade to upgrade db with script. - -flask db downgrade to rollback db changes. - -flask db current to show current script. +Note that we manually rename the auto-generated files so the prefix is a sequential number instead of a SHA. This means the files are listed in order, so it's easier to navigate the migration history.