Add more details to update subcommand page
#877
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
I think the guide can be much simpler; maybe so much so that it could be part of the doc page for the update command itself.
I don't think we need to distinguish the case where you update whatever files you have locally vs pulling first and then updating.
The doc only needs to:
- explain why you'd want to run
pgroll update(the breaking change case you describe here). - give an example of how you use it against a local
migrations/folder.
I'd be in favour of putting that in the docs for the update command and not having this guide.
docs/guides/updatemigrations.mdx
Outdated
| In this guide, we are going to learn how to update `pgroll` migration files in case there is a breaking change in the latest release. | ||
|
|
||
| <Warning> | ||
| `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 the subcommand `update` to make sure all your local migrations are correct. |
There was a problem hiding this comment.
Suggested change
| `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 the subcommand `update` to make sure all your local migrations are correct. | |
| `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. |
pgrollupdate subcommand page
Explain what the command is used for.
andrew-farries
approved these changes
Jun 30, 2025
|
Thank you! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds more details to
updatecommand.Requires #855