Skip to content

Commit

Permalink
upgrade dependencies (#1959), update docs (#1991)
Browse files Browse the repository at this point in the history
  • Loading branch information
mikkonie committed Sep 12, 2024
1 parent e65ab54 commit 6228314
Show file tree
Hide file tree
Showing 5 changed files with 139 additions and 45 deletions.
37 changes: 37 additions & 0 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,43 @@ Changelog for the SODAR project. Loosely follows the
`Keep a Changelog <http://keepachangelog.com/en/1.0.0/>`_ guidelines.


Unreleased
==========

Added
-----

- **General**
- Python v3.11 support (#1922, #1978)
- **Landingzones**
- REST API list view pagination (#1994)
- **Samplesheets**
- REST API list view pagination (#1994)

Changed
-------

- **General**
- Upgrade to django-sodar-core v1.0.2 (#1922)
- Upgrade to Postgres v16 (#1922)
- Upgrade Python and Vue app dependencies (#1922, #1959)
- **Irodsinfo**
- Update REST API versioning (#1936)
- **Landingzones**
- Update REST API versioning (#1936)
- Update REST API views for OpenAPI compatibility (#1951)
- **Samplesheets**
- Update REST API versioning (#1936)
- Update REST API views for OpenAPI compatibility (#1951)

Removed
-------

- **General**
- Python v3.8 support (#1922)
- Postgres <v12 support (#1922)


v0.15.1 (2024-09-12)
====================

Expand Down
2 changes: 1 addition & 1 deletion docs_manual/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
author = 'BIH Core Unit Bioinformatics'

# The full version, including alpha/beta/rc tags
release = '0.15.1'
release = '1.0.0-WIP'


# -- General configuration ---------------------------------------------------
Expand Down
45 changes: 45 additions & 0 deletions docs_manual/source/sodar_release_notes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,51 @@ list of changes in current and previous releases, see the
:ref:`full changelog<sodar_changelog>`.


v1.0.0 (WIP)
============

Release for SODAR Core v1.0 upgrade and feature updates.

- Add Python v3.11 support
- Add REST API list view pagination
- Update REST API versioning
- Update REST API views for OpenAPI support
- Upgrade to Postgres v16
- Upgrade to SODAR Core v1.0.2
- SODAR Core v1.0 updates: OIDC auth support, new REST API versioning,
owner/delegate remote sync controls etc.
- Upgrade to Django v4.2
- Remove Python v3.8 support
- Remove Postgres <12 support

Migration Guide
---------------

Python Version Support
Python v3.11 is now the recommended Python version. Support for v3.8 has
been dropped. It is recommended to upgrade your deployment for Python v3.11.
PostgreSQL Version Support
This release drops support for Postgres versions below v12. The recommended
version is v16. Note that if you run both the SODAR Server and the iRODS
iCAT server on the same PostgreSQL database server, you may need to upgrade
your iRODS server. The CUBI iRODS v4.2 Docker image does not support
Postgres >11. See the latest dev version of sodar-docker-compose for more
information.
REST API Versioning Changes
REST API versioning has changed in SODAR Core v1.0 and SODAR Server v1.0.
Accept header versioning is now specific to each Django app providing their
own API. The APIs now use semantic versioning and have individual version
numbers starting at ``1.0``. There is no backwards compatibility for old
version numbers. If your clients or scripts make use of the versioning, you
will need to consult the REST API documentation and update them accordingly.

.. warning::

It is strongly recommended to backup your SODAR and iRODS databases before
upgrading to this version due to the changed database requirements. Also it
is strongly recommended to go through all documentation before upgrading.


v0.15.1 (2024-09-12)
====================

Expand Down
98 changes: 55 additions & 43 deletions samplesheets/vueapp/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion samplesheets/vueapp/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "samplesheets",
"version": "0.15.1",
"version": "1.0.0-WIP",
"private": true,
"scripts": {
"serve": "vue-cli-service serve",
Expand Down

0 comments on commit 6228314

Please sign in to comment.