Repository navigation
Exit Codes
github-actions[bot] edited this page Nov 17, 2026
·
1 revision
The tool, the migrations project and bundles all use the same exit codes, so a pipeline can
act on them. With --json, the last line's result carries the same code.
| Code | Meaning | Typical cause |
|---|---|---|
0 |
Success. | |
1 |
A migration failed, or another error. | A migration threw; bad config; can't connect. |
2 |
Pending migrations or collection changes exist. |
plan, or status --check. |
3 |
Timed out waiting for the lock. | Another run is in progress. See Troubleshooting. |
4 |
Validation failed. | An edited, missing or out-of-order migration; an invalid collection definition; a collection change that isn't allowed. |
5 |
The tool and runner have no protocol version in common. | The tool is older than the Kevsoft.MigrateMongo.Runner in your project. Update the tool. |
6 |
Building the migrations project failed. | A compile error, including build errors from the source generator. |
status=0
migrate-mongo plan --env prod || status=$?
case $status in
0) echo "Nothing to deploy" ;;
2) migrate-mongo up --env prod ;;
*) exit 1 ;;
esacThe || keeps set -e (the default in GitHub Actions) from stopping the script when plan exits with 2.
When you run from your application, IMongoMigrationRunner results have
the same ExitCode.
Kevsoft.MigrateMongo ·
NuGet ·
Releases ·
Issues ·
Found a mistake? These pages live in
wiki/ on main; pull requests welcome.
Get started
Migrations
- Writing Migrations
- Transactions
- Recording Results
- Dependency Injection
- Custom Templates
- Adopting an Existing Database
Collections
- Managing Collections
- Indexes
- Search Indexes
- Collection Options
- Validators
- Views
- Undeclared Collections
Deploying
Connecting
Reference
Concepts