Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

BC-6620 - update info about migration pending command #23

Merged
merged 3 commits into from
May 27, 2024
Merged

BC-6620 - update info about migration pending command #23

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7116a6f
BC-6620 - update info about migration pending command
virgilchiriac Feb 26, 2024
4fdcb0b
corrected migration create command
virgilchiriac May 25, 2024
afc2f08
Merge branch 'main' into BC-6620-migration-pending
virgilchiriac May 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions docs/schulcloud-server/Migrations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ We use the [cli commands](https://mikro-orm.io/docs/5.9/migrations#using-via-cli


### Create a new migration
`npx run migration:create` will create a new migration file in `./apps/server/src/migrations/mikro-orm` folder.
`npx mikro-orm migration:create` will create a new migration file in `./apps/server/src/migrations/mikro-orm` folder.
* please note that argument `--name=SOME_MIGRATION_NAME` is supported in 5.9 only
* do log all database changes (before and after state of documents or at least all modified document id's)

Expand All @@ -31,7 +31,9 @@ To run migraitons you can use one of the commands below:


## Test migration
* to check migrations to be executed, you can use `npx mikro-orm migration:pending` command
* to check migrations to be executed:
* in local development you can use `npx mikro-orm migration:pending` command
* `npm run migration:pending` to run the compiled js file. The second command is safer, and used in CI and should be used in K8 clusters.
* The CI job `./.github/workflows/migrations.yml` will check that the migrations are already included in the seed data. If not, it will fail. This is to ensure that the seed data is always up to date with the migrations.

## Committing a migration
Expand All @@ -46,7 +48,7 @@ Commit the changes:
* `git add .`
* `git commit -m "migration: <migration name>"`
* `git push`
* test that the migration was applied `npx mikro-orm migrations:pending` should return nothing
* test that the migration was applied `npx mikro-orm migrations:pending` (or better use `npm run migration:pending`) should return nothing


## Best Practices
Expand Down Expand Up @@ -91,4 +93,4 @@ Commit the changes:
* According to documentation, the entity manager should not be used in migrations. Instead, the migration should use the `mongoClient` to access the database.
#### Outdated Migrations
* By their nature, migrations become outdated as the database model changes. You are never expected to update migrations due to any changes in the code that are made.
* If needed, for example because the migration shows errors due to a code (model) change, migrations can be deleted, since they will still be accessible in the git history.
* If needed, for example because the migration shows errors due to a code (model) change, migrations can be deleted, since they will still be accessible in the git history.
Loading