docs: clarify annotation requirement and ordering (pressly#452)

EBSCOIS · Jan 24, 2023 · 635add3 · 635add3
1 parent 74eaeab
commit 635add3
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -216,6 +216,9 @@ CREATE TABLE post (
 DROP TABLE post;
 ```
 
+Each migration file must have exactly one `-- +goose Up` annotation. The `-- +goose Down` annotation
+is optional. If the file has both annotations, then the `-- +goose Up` annotation **must** come first.
+
 Notice the annotations in the comments. Any statements following `-- +goose Up` will be executed as part of a forward migration, and any statements following `-- +goose Down` will be executed as part of a rollback.
 
 By default, all migrations are run within a transaction. Some statements like `CREATE DATABASE`, however, cannot be run within a transaction. You may optionally add `-- +goose NO TRANSACTION` to the top of your migration