Skip to content

Commit a8d53d4

Browse files
committed
v13: add upgrade step to remove invenio-admin
1 parent db0cb7d commit a8d53d4

File tree

2 files changed

+34
-3
lines changed

2 files changed

+34
-3
lines changed

docs/releases/v12/upgrade-v12.0.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -107,6 +107,21 @@ Install InvenioRDM v12:
107107
invenio-cli install
108108
```
109109

110+
### Activate the virtual environment
111+
112+
Before running any `invenio` commands, activate your virtual environment shell:
113+
114+
```bash
115+
$ invenio-cli shell
116+
Launching subshell in virtual environment...
117+
source <path to virtualenvs>/bin/activate
118+
```
119+
120+
This step ensures that all subsequent commands use the correct Python environment and installed dependencies.
121+
122+
!!! note
123+
If you are upgrading in an environment that does not use a Python virtualenv, you can skip this step.
124+
110125
### Database migration
111126

112127
Execute the database migration:

docs/releases/v13/upgrade-v13.0.md

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,8 @@ cd <my-site>
4848

4949
# Upgrade to InvenioRDM v13
5050
invenio-cli packages update 13.0.0
51-
51+
# The old `invenio-admin` dependencies has been removed and must be uninstalled
52+
pipenv run pip uninstall -y invenio-admin
5253
# Re-build assets
5354
invenio-cli assets build
5455
```
@@ -106,6 +107,21 @@ Install InvenioRDM v13:
106107
invenio-cli install
107108
```
108109

110+
### Activate the virtual environment
111+
112+
Before running any `invenio` commands, activate your virtual environment shell:
113+
114+
```bash
115+
$ invenio-cli shell
116+
Launching subshell in virtual environment...
117+
source <path to virtualenvs>/bin/activate
118+
```
119+
120+
This step ensures that all subsequent commands use the correct Python environment and installed dependencies.
121+
122+
!!! note
123+
If you are upgrading in an environment that does not use a Python virtualenv, you can skip this step.
124+
109125
### Database migration
110126

111127
Execute the database migration:
@@ -187,8 +203,8 @@ Be sure to repeat the [Rebuild search indices](#rebuild-search-indices) step to
187203
#### Jobs
188204
The new Jobs feature uses a custom celery task scheduler which requires a separate celery beat. See the [related documentation](../../operate/customize/jobs.md#scheduler) or [the scheduler service](https://github.com/inveniosoftware/cookiecutter-invenio-rdm/blob/ff6c652091d56e7a8aa0a90487f91352f70c4e33/%7B%7Bcookiecutter.project_shortname%7D%7D/docker-compose.full.yml) in the InvenioRDM boilerplate for how to add it.
189205

190-
!!! note
191-
Be sure to run this additional Celery beat scheduler in your production or deployed environments. Without it, scheduled and on-demand jobs will not be executed.
206+
!!! warning
207+
Be sure to run this additional Celery beat scheduler in **your Docker Compose, any deployed and production environments**. Without it, scheduled and on-demand jobs will not be executed.
192208

193209
#### Updated PDF previewer
194210
The updated PDF file previewer (PDF.js v4) now uses ECMAScript modules (`.mjs`) instead of CommonJS files (`.js`). By default, the `nginx` web server does not recognize `.mjs` files in its [default MIME types configuration](https://github.com/nginx/nginx/blob/master/conf/mime.types#L8). As a result, the MIME type may be reported incorrectly, causing browsers to block the file and resulting in broken PDF previews.

0 commit comments

Comments
 (0)