Skip to content

Commit 2a8d853

Browse files
max-moserfenekku
andcommitted
feat(v13.1): add documentation about the v13.1 release
Co-authored-by: Guillaume Viger <fenekku@users.noreply.github.com>
1 parent 33f8aca commit 2a8d853

File tree

2 files changed

+91
-0
lines changed

2 files changed

+91
-0
lines changed
Lines changed: 90 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
1+
# InvenioRDM v13.1
2+
3+
*2026-03-27*
4+
5+
We are happy to announce the release of InvenioRDM v13.1. This is a minor release which will become the maintained tip of v13.
6+
Future patches for v13 will land on this minor version only.
7+
8+
9+
## What's new?
10+
11+
InvenioRDM v13.1 primarily backports the [request reviewers feature](../../maintenance/architecture/requests.md#reviewers-in-requests) to InvenioRDM v13.
12+
13+
This feature allows the selection of users (or groups) as "reviewers" for requests.
14+
The selected reviewers will gain access to the request and its timeline (i.e. associated events and comments), and be able to comment on the request too.
15+
16+
!!! warning "Enabling the feature requires reindexing the requests"
17+
The information about the set of reviewers is stored in a new field in the request itself, so the schema has changed.
18+
Enabling the feature will require the search mappings to be updated, and the requests to be reindexed.
19+
For more details, see the [upgrade section below](#upgrading-from-v130-to-v131).
20+
21+
22+
### Selecting reviewers for requests
23+
24+
The new request reviewers feature is (currently) opt-in, so you'll have to enable the `REQUESTS_REVIEWERS_ENABLED` feature flag via the configuration.
25+
Additionally, the behavior can be tweaked with a few more configuration items:
26+
27+
```python
28+
REQUESTS_REVIEWERS_ENABLED = True
29+
"""Enable the request reviewers feature."""
30+
31+
REQUESTS_REVIEWERS_MAX_NUMBER = 15
32+
"""Maximum number of reviewers allowed for a request."""
33+
34+
USERS_RESOURCES_GROUPS_ENABLED = True
35+
"""Config to enable features related to existence of groups.
36+
37+
Makes groups available for selection as request reviewers, in addition to users.
38+
"""
39+
```
40+
41+
**Note** that the feature flag currently enables the request reviewers feature for *all kinds of requests*.
42+
43+
44+
### Other notable changes
45+
46+
Even though the upgrade pulls in a number of major version bumps, there are actually only relatively few large changes.
47+
Most of the major releases there just bump their own dependencies (to better isolate from breaking changes) rather than introducing breaking changes themselves.
48+
49+
Here are the most noteworthy changes:
50+
51+
* [`Invenio-Users-Resources` v9.0.0](https://pypi.org/project/invenio-users-resources/9.0.3/): Tightened permissions for users endpoints in the REST API, and change of HTTP status code from `403` to `404` on permission errors for increased privacy
52+
* [`Invenio-RDM-Records` v20.2.0](https://pypi.org/project/invenio-rdm-records/20.2.0/): Renaming of several `React-Overridable` IDs; the full list of changed IDs is available in the [changelog for v20.2.0](https://github.com/inveniosoftware/invenio-rdm-records/blob/v20.2.0/CHANGES.rst?plain=1)
53+
54+
55+
56+
## Upgrading from v13.0 to v13.1
57+
58+
59+
The first step of the upgrade process is of course to **install the new packages**.
60+
To do so, make sure that the version specifiers for the Invenio-App-RDM dependency in your project definition (`pyproject.toml`, `Pipfile`, ...) allow for the `13.1.x` range of releases, e.g. `invenio-app-rdm[opensearch2]~=13.1.0`.
61+
62+
The new packages should be found and installed via `invenio-cli install`.
63+
If the v13.1 release of Invenio-App-RDM still doesn't get pulled in, remove your lock file (`uv.lock`, `Pipfile.lock`, ...) and try again.
64+
65+
After installing the new packages, you'll need to **rebuild your frontend assets**, and **update the search mappings for the requests index and reindex all requests**.
66+
67+
For *local development setups*, the frontend assets have been built as part of `invenio-cli install` already.
68+
For *containerized setups*, this typically just requires rebuilding your container images; the frontend build is part of the default [`Dockerfile`](https://github.com/inveniosoftware/cookiecutter-invenio-rdm/blob/v13.0/%7B%7Bcookiecutter.project_shortname%7D%7D/Dockerfile).
69+
If the frontend assets seem stale after spinning up the newly built containers, the culprit is often an outdated `static_data` volume.
70+
Removing it and restarting the containers usually fixes this issue.
71+
Just make sure not to delete the wrong volumes!
72+
73+
The search mappings and indexed requests can be updated with the following commands:
74+
75+
```bash
76+
# update the search mappings for requests to include reviewers
77+
invenio index update requests-request-v1.0.0 --no-check
78+
79+
# start bulk reindexing for all requests
80+
invenio rdm rebuild-all-indices --order requests
81+
```
82+
83+
That's it.
84+
Other search indices like request events aren't affected and don't need to be updated.
85+
86+
!!! info "No action needed if you don't want to use the feature"
87+
If you *do not* intend to enable the request reviewers feature, no further action is necessary after upgrading the installed packages.
88+
But updating the mappings won't hurt either.
89+
90+
Enjoy v13.1! 😎

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -214,6 +214,7 @@ nav:
214214
- Upgrade policy: releases/upgrade-policy.md
215215
- Security policy: releases/security-policy.md
216216
- Version v13:
217+
- Release Notes v13.1: releases/v13/version-v13.1.0.md
217218
- Release Notes v13.0: releases/v13/version-v13.0.0.md
218219
- Upgrade from v12 to v13: releases/v13/upgrade-v13.0.md
219220
- Version v12:

0 commit comments

Comments
 (0)