docs: Clarify how migrations are applied with serverpod start#599
Open
Zfinix wants to merge 1 commit into
Open
docs: Clarify how migrations are applied with serverpod start#599Zfinix wants to merge 1 commit into
Zfinix wants to merge 1 commit into
Conversation
Swiftaxe
reviewed
Jun 12, 2026
| ## Apply migrations | ||
|
|
||
| Migrations are applied using the server runtime. To apply migrations, navigate to your project's `server` package directory, then start the server with the `--apply-migrations` flag. Migrations are applied as part of the startup sequence and the framework asserts that each migration is only applied once to the database. | ||
| During local development, `serverpod start` applies your migrations for you: pending migrations run on the first boot, and you can apply new ones at any time by pressing **A** in the terminal UI. |
Collaborator
There was a problem hiding this comment.
Nit: Users scan documentation real quick. When scanning quickly, the text "pressing A" disappears and what stands out is the "dart run bin/main.dart...". Consider following the pattern in the "Build your first app", where Press R stands out by using a bullet.
The same goes for "production and automated pipeline" which disappears in text. Consider if this should be a heading, to catch the attention of users searching for those particular use cases.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Summary
Notes that
serverpod startapplies migrations during local development (on first boot, or by pressing A in the terminal UI). The explicit--apply-migrationsruntime command stays documented for production and automated pipelines.The remaining
dart run bin/main.dartmentions are intentional: the--role maintenanceand production invocations are runtime calls thatserverpod startshould not replace (it is a development tool and always applies migrations).Part of #565