Skip to content

Include 6.1 changes to main #565

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.

Sign up for GitHub

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
erikbosch merged 1 commit into from
Sep 17, 2026
Merged

Include 6.1 changes to main #565

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 9 additions & 2 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,21 +5,28 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

> [!IMPORTANT]
> This document only contain changes introduced in VSS-Tools 3.0 or later

## [Unreleased]

## 6.1

### Added

- `vspec compose` command: bundles a vspec model and all its dependencies (includes, overlays, units, quantities) into a self-contained snapshot folder. Validates the full expanded model before writing, then serialises the raw authored content faithfully — preserving `instances`, instance-level overrides, and custom struct types. See [compose.md](docs/compose.md).
- `vspec diff` command: compares two compose snapshots and reports every change (ADDED, REMOVED, MODIFIED) as structured JSON. Detects renames via the `fka` field and cascades them to child nodes automatically. See [diff.md](docs/diff.md).
- `includes` now supported as property as an alternative to `#include`
- New attribute `instances_relation` to support sibling relationship
- qudt supported for units
- Avro exporter added
- VHAL exporter added

### Changed

- **Breaking**: Unit descriptions (`unit` field) must now be globally unique across all quantities. Previously accepted duplicate unit descriptions in `units.yaml` will now fail validation with a clear error message identifying the conflicting unit keys.
- **Breaking**: `vspec export id` now writes struct/type static UIDs to `--types-output` (or, if omitted, to a file named `structs_<output>` next to `--output`) instead of merging them into the main `--output` file. Previously, using `--types` produced a vspec with two top-level roots that other tools cannot load.
- Enhanced `s2dm` exporter that provides increased traceability of the performed mapping, reporting name conversions, correspondences, etc.
- Minimum Python version is now 3.11


## 6.0

Expand Down
Loading
Loading