github/overleaf
1
0
Fork 0
mirror of https://github.com/overleaf/overleaf.git synced 2024-11-21 20:47:08 -05:00
Code Issues Projects Releases Packages Wiki Activity

Merge pull request #15921 from overleaf/jpa-migrations-via-rake

Browse source 
[web] update README for migrations to point at rake tasks

GitOrigin-RevId: 35f5931292fd389928fbf070d71f6b18387fe496
This commit is contained in:
Jakob Ackermann 2023-11-23 16:36:39 +01:00 committed by Copybot
parent be6206845e
commit e120f61a9a
1 changed files with 24 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

33
services/web/migrations/README.md
View file

@ -3,12 +3,17 @@
Migrations for the app environment live in this folder, and use the [East](https://github.com/okv/east) migration Migrations for the app environment live in this folder, and use the [East](https://github.com/okv/east) migration
framework. framework.
We have an npm script which wraps east: `npm run migrations -- ...` We have a npm script which wraps east: `npm run migrations -- ...`
For example: For example:
``` sh ```shell
npm run migrations -- list -t 'saas' npm run migrations -- list -t 'server-ce'
```
For SAAS, use the rake tasks for staging/production
```shell
rake deploy:migrations:list[staging]
``` ```
### Environments and Tags ### Environments and Tags
@ -30,7 +35,7 @@ Our adapter will refuse to run if this flag is not set.
To create a new migration, run: To create a new migration, run:
``` ```shell
npm run migrations -- create <migration name> npm run migrations -- create <migration name>
``` ```
@ -42,18 +47,28 @@ undo the changes made in `migrate`.
To run a script in a migration file, look at `migrations/20190730093801_script_example.js`, which runs the script To run a script in a migration file, look at `migrations/20190730093801_script_example.js`, which runs the script
`scripts/example/script_for_migration.js`. This uses a method where the script can be run standalone via `node`, or `scripts/example/script_for_migration.js`. This uses a method where the script can be run standalone via `node`, or
through the migrations mechanism. through the migrations' mechanism.
### Running migrations ### Running migrations
To run all migrations in a server-ce environment: To run all migrations in a server-ce environment:
``` sh ```shell
npm run migrations -- migrate -t 'server-ce' npm run migrations -- migrate -t 'server-ce'
# Note: They are run by default on container start.
``` ```
To run all migrations in a saas environment: To run all migrations in a SAAS environment use the rake task:
``` sh ```shell
npm run migrations -- migrate -t 'saas' # list first and check that only your newly added migration is shown. If not, ask in the dev channel for help.
rake deploy:migrations:list[staging]
# After confirming the listing, run the migrations
rake deploy:migrations[staging]
```
To run all migrations in the dev-env:
```shell
make services/web/migrate
# Note: "make install" will pick them up as well
``` ```
The `-t` flag also works with other `east` commands like `rollback`, and `list`. The `-t` flag also works with other `east` commands like `rollback`, and `list`.