Skip to content
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
8 changes: 7 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,11 @@ Pre-releases (`b*`, `rc*`) are not listed.

## [Unreleased]

## [3.6.0.0] - 2026-09-11

Targets cuvis SDK 3.6.0.
First wrapper release for that SDK.

### Added

- `cuvis.ReferenceType.WhiteSpectrum` - new enum member.
Expand Down Expand Up @@ -72,7 +77,8 @@ Pre-releases (`b*`, `rc*`) are not listed.
### Changed

- Whole tree reformatted with `ruff format`; no behaviour change.
- `pyproject.toml` - the `cuvis-il` requirement moved from `>=3.5.0,<3.6.0` to `>=3.6.0a0,<3.7.0`, so the wrapper targets cuvis SDK 3.6 and accepts the pre-releases of that SDK line.
- `pyproject.toml` - the `cuvis-il` requirement moved from `>=3.5.0,<3.6.0` to `>=3.6.0,<3.7.0`, so the wrapper targets cuvis SDK 3.6.
- `CONTRIBUTING.md`, `README.md` - the branch model is now trunk based: `develop` is gone, every change is cut from `main` and merged back into it by pull request, and a commit on `main` is no longer necessarily a release.
- `cuvis.ProcessingContext.set_reference` - type changed from `(mesu: Measurement, refType: ReferenceType)` to `(data: Measurement | ImageData | tuple, refType: ReferenceType)`.
The spectrum reference types take spectrum data instead of a `Measurement`; the first parameter is renamed from `mesu` to `data`.
- `README.md` - documents the version scheme, and lists Python 3.14 among the supported interpreters as `pyproject.toml` already did.
Expand Down
28 changes: 13 additions & 15 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,18 +7,17 @@ For bug reports and questions use [GitHub Issues](https://github.com/cubert-hype

| Branch | Role |
| --- | --- |
| `main` | The latest released wrapper state for the latest released cuvis SDK. Every commit on `main` is a release and carries a `v*` tag. Never receives direct pushes. |
| `develop` | Integration branch for the next release. All feature work lands here. |
| `feature/*` | One branch per change, cut from `develop`, merged back into `develop` by pull request. |
| `hotfix/*` | Cut from `main` when a released version needs a fix before `develop` is ready to release. Merged into `main` by pull request, tagged, then merged back into `develop`. |
| `main` | Trunk, and the latest released wrapper state for the latest released cuvis SDK. Never receives direct pushes. |
| `feature/*` | One branch per change, cut from `main`, merged back into `main` by pull request. |
| `release/vX.Y` | Maintenance branch for an older SDK line that still receives wrapper revisions. Cut from the corresponding tag on demand. |

```
feature/* -> develop -> main (tag vX.Y.Z.W)
hotfix/* -> main (tag vX.Y.Z.W) -> develop
feature/* -> main (tag vX.Y.Z.W)
```

A pull request into `develop` or `main` must pass the `ci.yml` lint and test jobs.
A release is a `v*` tag on a commit of `main`; not every commit on `main` is a release.

A pull request into `main` must pass the `ci.yml` lint and test jobs.

## Version scheme

Expand Down Expand Up @@ -143,18 +142,18 @@ The release workflow depends on settings that live outside the repository:
- **Environments.** `testpypi` and `pypi` must exist under Settings -> Environments.
`pypi` carries the required reviewers that make step 7 below a human gate; without them the release
publishes unattended.
- **Branch protection.** `main` and `develop` require the `Lint`, `Changelog` and `Tests` checks from
`ci.yml`, and `main` additionally forbids direct pushes.
- **Branch protection.** `main` requires the `Lint`, `Changelog` and `Tests` checks from `ci.yml`
and forbids direct pushes.

### Regular release from `develop`
### Cutting a release

1. On `develop`, confirm which SDK version the wrapper targets and that `cuvis-il` in `pyproject.toml` matches it.
1. On a `feature/*` branch cut from `main`, confirm which SDK version the wrapper targets and that `cuvis-il` in `pyproject.toml` matches it.
2. For a final version rename `## [Unreleased]` to `## [X.Y.Z.W] - <today>` and add the SDK statement lines beneath it.
Add a fresh empty `## [Unreleased]` above it.
For a pre-release leave the entries under `## [Unreleased]`.
3. Set `[project].version` in `pyproject.toml` to `X.Y.Z.W` (or `X.Y.Z.WrcN`).
4. Run `ruff format --check . && ruff check . && pytest`.
5. Open a pull request `develop` -> `main` titled `release: vX.Y.Z.W` and merge it once CI is green.
5. Open a pull request into `main` titled `release: vX.Y.Z.W` and merge it once CI is green.
6. Tag the merge commit on `main` and push the tag:

```bash
Expand All @@ -164,11 +163,10 @@ The release workflow depends on settings that live outside the repository:
```

7. `release.yml` validates the tag, builds, publishes to TestPyPI, and then waits for approval on the `pypi` environment before publishing to PyPI and, for a final version, creating the GitHub Release.
8. Merge `main` back into `develop` so the release commit is an ancestor of both.

### Hotfix release from `main`
### Fixing a released version

Same as above, except the branch is `hotfix/<slug>` cut from `main`, the pull request targets `main` directly, only `PATCH` increases, and step 8 becomes mandatory rather than tidy-up.
An ordinary change: branch from `main`, raise only `PATCH`, and follow the same steps.

### If a release goes wrong

Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ Wrapper versions are `GENERATION.MAJOR.MINOR.PATCH`.
`GENERATION.MAJOR.MINOR` is the Cuvis C SDK release this wrapper targets, and `PATCH` counts wrapper-only
revisions against that same SDK; `3.5.3.1` is a wrapper fix on top of `3.5.3.0`, both for SDK 3.5.3.

`main` always points at the latest released wrapper state, `develop` at the next release.
`main` is the trunk and points at the latest released wrapper state; every release is a `v*` tag on one of its commits.
Every release is listed in [CHANGELOG.md](CHANGELOG.md).
The scheme and the release process are documented in [CONTRIBUTING.md](CONTRIBUTING.md).

Expand Down
4 changes: 2 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"

[project]
name = "cuvis"
version = "3.6.0.0rc2"
version = "3.6.0.0"
description = "CUVIS Python SDK."
readme = "README.md"
requires-python = ">=3.10"
Expand All @@ -14,7 +14,7 @@ authors = [
]

dependencies = [
"cuvis-il>=3.6.0a0,<3.7.0",
"cuvis-il>=3.6.0,<3.7.0",
"setuptools; python_version>='3.12'" # Only for Python 3.12+
]

Expand Down