Skip to content

Commit b593e98

Browse files
committed
chore: clarify upgrade instructions
1 parent 9a897a4 commit b593e98

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -28,15 +28,15 @@ You'll very likely want to put RecipeSage behind a reverse proxy for SSL termina
2828

2929
### Updating
3030

31-
First, _take a look at the changelog below for any special upgrade notes_. Then follow the steps below.
32-
3331
By default, the database will be automatically migrated when updating to a new container version. As with any migration/upgrade, I **strongly recommend taking a backup** of your volumes before migrating to avoid any potential data loss. My first recommendation when encountering issues after an update will be to rollback, which will be impossible if you don't have a backup.
3432

35-
Update your local copy of this repo with the latest from this repository. If cloned with Git, this is as simple as `git pull`.
33+
1. [_Take a look at the changelog below for any special upgrade notes_](#changelog). Then follow the steps below.
34+
35+
2. Update your local copy of this repo with the latest from this repository. If cloned with Git, this is as simple as `git pull`.
3636

37-
Update your local images: `docker compose pull`.
37+
3. Update your local images: `docker compose pull`.
3838

39-
Then, down & up the containers: `docker compose down --remove-orphans && docker compose up -d`
39+
4. Down & up the containers: `docker compose down --remove-orphans && docker compose up -d`
4040

4141
<br />
4242

@@ -100,11 +100,11 @@ The `ingredient-instruction-classifier` container facilitates machine learning c
100100

101101
Migrations are now automated, and use a different migration tool.
102102

103-
If you have an older version of this repository, you _must_ upgrade to this version of the repository and do the following before upgrading to newer versions:
103+
If you have an older version of this repository, you _must_ upgrade to this version of the repository and do the following before upgrading to newer versions so that migrations all line up:
104104

105105
1. Update your local copy of the repository to v4.0.0
106106
2. Run `docker compose exec api tsx packages/backend/src/migrate`
107-
3. Run `docker compose exec api npx prisma migrate resolve --applied 0_init`
107+
3. If the command prior ran successfully, run `docker compose exec api npx prisma migrate resolve --applied 0_init`
108108

109109
### v3.1.0
110110

0 commit comments

Comments
 (0)