Skip to content

v13: cleanup pass on release notes #835

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.

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

Merged
merged 1 commit into from
Jul 22, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 2 additions & 0 deletions docs/maintenance/architecture/curation.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Curation checks

_Introduced in v13_

**Intended audience**

This guide is intended for maintainers and developers of InvenioRDM itself.
Expand Down
11 changes: 6 additions & 5 deletions docs/operate/customize/dois.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ DATACITE_FORMAT = "{prefix}/inveniordm.{id}"
#### OAI-PMH

The OAI-PMH server's metadata format ``oai_datacite`` that allows your records
to be harvested in DataCite XML needs to be configured with your DataCite data
to be harvested in DataCite XML needs to be configured with your DataCite data
center symbol. This is only required if you want your records to be harvestable in DataCite XML format.

```python
Expand All @@ -86,14 +86,15 @@ DATACITE_DATACENTER_SYMBOL = "CERN.INVENIORDM"

### Versioning and externally managed DOI

By default, InvenioRDM allows versioning for any DOI type - internally or externally managed.
Internally managed DOIs are DOIs registered by your instance and minted on Datacite.
External DOIs are DOIs already minted and simply passed to your instance.
As such, having an internally managed DOI for the next version of a record with an external DOI may not be desired.
By default, InvenioRDM allows versioning for any DOI type - internally or externally managed.
Internally managed DOIs are DOIs registered by your instance and minted on Datacite.
External DOIs are DOIs already minted and simply passed to your instance.
As such, having an internally managed DOI for the next version of a record with an external DOI may not be desired.
To disable versioning for external DOIs you need to set

```python
RDM_ALLOW_EXTERNAL_DOI_VERSIONING = False
```

#### Parent or Concept DOIs

Expand Down
2 changes: 2 additions & 0 deletions docs/operate/customize/require_community.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Require community for record publication

_Introduced in v13_

Institutional policies may require all published records to belong to at least one community. InvenioRDM enforces this requirement through the `RDM_COMMUNITY_REQUIRED_TO_PUBLISH` configuration parameter.
To activate this feature, open your `invenio.cfg` and add:

Expand Down
2 changes: 1 addition & 1 deletion docs/operate/customize/vocabularies/funding.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ Create a new job called "Load Funders" in the Default queue with task "Load ROR
sure to check the "active" checkbox and click the save button.

Then click the "Configure and run" button, select the "celery" queue, and put
"1900-01-01" in the "Since" field. Click "Run now" and your affiliations will
"1900-01-01" in the "Since" field. Click "Run now" and your funders will
be loaded.

You can also use the "Schedule job" button to download the latest version of
Expand Down
1 change: 1 addition & 0 deletions docs/releases/v12/version-v12.0.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -130,6 +130,7 @@ Here is a quick summary of the myriad other improvements in this release:
- Great improvements in bulk serialization performance
- The communities REST endpoint accepts both UUID and slug in the URL
- Many new configuration variables (e.g., `COMMUNITIES_SEARCH_SORT_BY_VERIFIED`) to tune your instance
- The new `generator` HTML `meta` tag identifies the repository technology. This is used by services like [OpenDOAR](https://opendoar.ac.uk/) to correctly catalog open access repositories.
- ...and many more bug fixes!

## Breaking changes
Expand Down
36 changes: 17 additions & 19 deletions docs/releases/v13/upgrade-v13.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,22 +26,6 @@ invenio-cli, version 1.8.0
In case you are not inside a virtual environment, make sure that you prefix each `invenio`
command with `pipenv run`.

**Local development**

Changing the Python version in your development environment highly
depends on your setup, so we won't cover it here.
One way would be to use [PyEnv](https://github.com/pyenv/pyenv).

!!! warning "Risk of losing data"

Your virtual environment folder a.k.a., `venv` folder, may contain uploaded files. If you kept the default
location, it is in `<venv folder>/var/instance/data`. If you need to keep those files,
make sure you copy them over to the new `venv` folder in the same location.
The command `invenio files location list` shows the file upload location.

If you upgraded your python version, you should recreate your virtual environment before
running `invenio-cli` or `pipenv` commands below.

### Upgrade InvenioRDM

#### Requirements
Expand Down Expand Up @@ -75,6 +59,13 @@ This approach will create a new virtual environment and leaves the v12 one as-is
If you are using a docker image on your production instance this will be the
option you choose.

!!! warning "Risk of losing data"

Your virtual environment folder a.k.a., `venv` folder, may contain uploaded files. If you kept the default
location, it is in `<venv folder>/var/instance/data`. If you need to keep those files,
make sure you copy them over to the new `venv` folder in the same location.
The command `invenio files location list` shows the file upload location.

##### Step 1

- create a new virtual environment
Expand Down Expand Up @@ -193,7 +184,7 @@ If you choose to delete and re-create your search cluster as part of the upgrade
Be sure to repeat the [Rebuild search indices](#rebuild-search-indices) step to ensure your system is fully functional.

#### Jobs
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) on how to add it or [this change](https://github.com/inveniosoftware/cookiecutter-invenio-rdm/pull/314) in the InvenioRDM boilerplate for reference.
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.

!!! note
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.
Expand All @@ -216,10 +207,17 @@ To resolve this, simply add a custom [`types`](https://nginx.org/en/docs/http/ng

### Optional changes

#### Deprecated configurations
#### Deprecations

*`APP_ALLOWED_HOSTS`*

With the upgrade to Flask version 3, the configuration variable `APP_ALLOWED_HOSTS` has been renamed to `TRUSTED_HOSTS`. The value remains unchanged.
You should review your `invenio.cfg`, environment variables, and deployment configuration for any occurrences of the old variable name.
It is recommended to update all references to `TRUSTED_HOSTS` to avoid deprecation warnings in the console.
It is recommended to update all references to `TRUSTED_HOSTS` to avoid deprecation warnings in the console and prepare for its eventual complete removal.

*`invenio_records_resources.services.Link`*

Usage of `invenio_records_resources.services.Link` is deprecated in favor of `invenio_records_resources.services.EndpointLink` for InvenioRDM links and `invenio_records_resources.services.ExternalLink` for external third-party links. Replace instances of `Link` in your custom code, if any, appropriately. `Link` will be removed in a future major InvenioRDM release.

#### Display versions in administration panel
As described in the [release notes](./version-v13.0.0.md#miscellaneous-additions), you can now display the versions of your installed modules directly in the Administration panel.
Expand Down
Loading