Skip to content
Snippets Groups Projects
Commit 1106be5b authored by Yoann Schneider's avatar Yoann Schneider :tennis: Committed by Bastien Abadie
Browse files

Release notes 0.3.5

parent 7907cab7
No related branches found
No related tags found
1 merge request!433Release notes 0.3.5
Pipeline #141244 passed
# Releases
## 0.3.5
Released on **8 Nov 2023** • View on [Gitlab](https://gitlab.teklia.com/workers/base-worker/-/releases/0.3.5)
### Breaking changes
- The `arkindex_worker.reporting` module has been removed as the JSON report file was no longer needed.
- The `--model-dir` CLI argument was renamed to `--extras-dir` as it was more suited to its use. This folder now stores dataset archives, hence the more generic name.
### Arkindex API
- Following Arkindex [1.5.2](https://teklia.com/our-solutions/arkindex/releases/arkindex-release-152/) release,
- new helpers for Task-related endpoints were introduced,
- A new worker class is available, to support `Dataset` processes
- new helpers for Dataset-related endpoints were introduced,
- Added a unicity check on the input of the [create_transcription_entities](https://workers.arkindex.org/ref/api/entity/#arkindex_worker.worker.entity.EntityMixin.create_transcription_entities) helper.
- The [partial_update_element](https://workers.arkindex.org/ref/api/element/#arkindex_worker.worker.element.ElementMixin.partial_update_element) helper was updated to better match the endpoint.
### Documentation
- Some modules were poorly displayed in the documentation. Class methods are now only listed under their class's section.
### Release Management
- A *Makefile* was added to the worker template to deploy new releases more easily. The default branch expects [master](https://gitlab.teklia.com/workers/base-worker/-/blob/7907cab7b506f8468c538ab4f5b99da4ebfe999f/worker-%7B%7Bcookiecutter.slug%7D%7D/Makefile#L8), make sure to change it to `main` depending on your settings.
- The base image used in the worker's docker image was changed from `python:3.11` to `python:3.11-slim`, in an effort to reduce their size.
### Misc
- During the configuration stage, a summary of the worker is now logged instead of the revision's hash. This was changed to support workers not linked to any revision on Arkindex.
- A retry mechanism on HTTP 50x errors was added. Additionally, when the requested size exceeds the maximum size allowed by the IIIF server, a new try is done with `max` instead of `full` as size parameter. More information about these parameters in [the IIIF documentation](https://iiif.io/api/image/2.1/#size).
- When running the worker locally without the `ARKINDEX_CORPUS_ID` variable set in the environment, an explicit exception will be raised when trying to access the `corpus_id` attribute.
- This release adds support for [Python 3.12](https://docs.python.org/3/whatsnew/3.12.html).
## 0.3.4
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment