Skip to content

Update develop with 2.0.1 hotfix from main#482

Merged
s-heppner merged 5 commits into
developfrom
Update/develop_from_main
Apr 21, 2026
Merged

Update develop with 2.0.1 hotfix from main#482
s-heppner merged 5 commits into
developfrom
Update/develop_from_main

Conversation

@s-heppner

Copy link
Copy Markdown
Member

No description provided.

s-heppner and others added 5 commits December 5, 2025 09:08
Prepare Release v2.0.0

# Release Notes

Version 2.0.0 of the BaSyx-Python SDK comes with a major refactoring of the server and a renewed concept for data persistence.

Previously, the server code was split between the `sdk` and `server` packages (due to historic development of the code). 
Now all the code relevant just for the server is located in `server`, where it belongs. Since this means, some code that was previously in `sdk` is not there anymore, this is a breaking change and warranted the new major release.

> [!note]
> This release does not have any changes in implemented AAS specification versions. It is the preparotory release in order to get ready for the new versions of the specifications, as well as new features for the SDK, such as Registry and Discovery server.

> [!warning]
> Due to these major refactorings, there were some backward incompatible changes. Please check the documentation, if you encounter any issues.

# Changelog

**Notable:**
- Backward Incompatible: Refactor server functionality from `sdk` to `server` (See: #388)
- Backward Incompatible: Refactor `backend` concept for data persistence (See: #370)
- Backward Incompatible: Refactor server `start-up` options (See: #418)
- Remove support for Python 3.9 (as it is EoL) (See #433)

**Improvements:**
- Clarify documentation of running the server with Docker (See: #398)
- Document running the server without Docker (See: #403)
- Improve XML serialization (See: #406)
- Improve server reading of JSON and XML files (See: #408)
- Add more utility methods for `Referable` and `Key` handling (See: #410)

**Bugfixes:**
- Fix type issues found with a new version of `mypy` (See: #399)
- Fix parsing of `ConceptDescription`s in the server (See: #420)
- Update `pyecma376-2` and `lxml` dependencies (See: #419)
Previously, we had some weird bugs with the CI pipeline sometimes
failing (#400), but not always reproducible. Namely, sometimes the CI
failed, due to `mypy` not finding the `sdk` types when running from the
`compliance_tool` environment. Since currently, we are at a point where
it is impossible to reproduce the failing CI (at least for me), I
decided to clean up the job definitions a little bit and make some
things more explicit.

Namely, instead of calling scripts like `pip` or `mypy` from their PATH,
we now explicitly call them via `python -m pip` and `python -m mypy`.
This theoretically ensures, that it always uses the script we just
installed with the dependencies and not something the VM already had
in its path via `actions/setup-python@v5`.
This should ensure that a script like `mypy` actually has all the
necessary dependencies installed.

Secondly, we had a `pip install -e ../sdk[dev]`, therefore installing
the development dependencies of the `sdk` in the `compliance_tool` CI
check. This is technically incorrect, since we use the `sdk` as external
dependency and therefore shouldn't depend on the development
dependencies. I therefore removed this.

Lastly, the `sdk-readme-codeblocks` check uses `bash` syntax. In theory,
the Ubuntu environment should use `bash` by default, but now it is made
explicit.

Fixes #400 (hopefully)
)

This adds a `server-publish` configuration that publishes
the server Docker image on DockerHub. The logic is 
in line with the basyx-java-server. 

---------

Co-authored-by: s-heppner <iat@s-heppner.com>
Remove multiplatform support from DockerHub publishing for now

---------

Co-authored-by: Sercan Sahin <s.sahin@iat.rwth-aachen.de>
@s-heppner s-heppner merged commit d99c15a into develop Apr 21, 2026
29 checks passed
@s-heppner s-heppner deleted the Update/develop_from_main branch April 21, 2026 08:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants