Skip to content

Commit 063a244

Browse files
kvchandrew-farries
andauthored
Add more details to update subcommand page (#877)
This PR adds more details to `update` command. Requires #855 --------- Co-authored-by: Andrew Farries <[email protected]>
1 parent e01a51f commit 063a244

File tree

1 file changed

+10
-4
lines changed

1 file changed

+10
-4
lines changed

docs/cli/update.mdx

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Update
3-
description: Update migration files that contain breaking changes
3+
description: Update migration files to the latest file format
44
---
55

66
## Command
@@ -9,11 +9,17 @@ description: Update migration files that contain breaking changes
99
$ pgroll update {migrations-folder}
1010
```
1111

12-
This command updates all outdated migration files in the selected migrations folder.
12+
The `pgroll update` command updates migration files to the latest file format; use it when a new version of `pgroll` contains breaking changes to the migration file JSON/YAML schema.
1313

14-
The optional `--json` flag can be used to write migration files in JSON.
14+
The optional `--json` flag can be used to write migration files in JSON format instead of YAML.
1515

16-
### Example for updating migrations in the folder `migrations`
16+
<Warning>
17+
`pgroll` hasn't reached v1 yet, so we are releasing breaking changes from time to time. Adopting these changes can be painful manually. We suggest you use `pgroll update` to make sure all your local migrations are correct.
18+
</Warning>
19+
20+
### Example for updating migrations in the `migrations` folder
21+
22+
Update all migrations in the `migrations/` folder:
1723

1824
```
1925
$ pgroll update migrations

0 commit comments

Comments
 (0)