Skip to content

ci: prepare v1.8.8 release - #305

Open
vboussot wants to merge 2 commits into
mainfrom
ci/changelog-v1.8.8
Open

vboussot wants to merge 2 commits into
mainfrom
ci/changelog-v1.8.8

Conversation

@vboussot

@vboussot vboussot commented Nov 2, 2026 •

Copy link
Copy Markdown
Member

Release notes for 1.8.8, from main at 3a14b2f. The section describes the user-visible changes and migrations; earlier sections are preserved byte-for-byte. No runtime or package version file changes.

Validation so far:

  • CI of main at 3a14b2f: konfai_ci, konfai_apps_ci, konfai_mcp_ci and konfai_studio_ci are green.
  • release_notes.py v1.8.8 reads the section, classifies the tag as stable, and tests/unit/test_release_notes.py passes.
  • Rehearsal from wheels built at this commit with version 1.8.8 (konfai, konfai-apps, impact-reg-konfai; exact sibling pins checked), non-editable, in a new venv on Python 3.14: pip install of the public tutorial's requirements, its four notebooks with the published presets (0 errors, correlation -0.06 to 0.90, nuclei Dice 0.00 to 0.92, pair.ozx 42 MB).
  • In that venv, the claims of this section: Transform.h5 is an AffineTransform, --set transform_type=field gives the field back, an ensemble and --tta refuse the affine by name, eval reads it.
  • Bundles: the weights every app.json names are present as .safetensors, and the 99 published configs validate against the schema of this commit.

Not run: pixi run perf-check. Other jobs hold the machine (load average above 25), and its gate refuses to time there.

Summary by CodeRabbit

  • Breaking Changes
    • Updated preset length units and Generic_Rigid transform output.
  • New Features
    • Added support for affine transforms, 2-D and remote registration, initialization, HTTPS, workflow schemas, safetensors, and Python 3.14.
  • Bug Fixes
    • Fixed OME-Zarr fields and outputs, multi-time-point store handling, prediction hangs, resampling, and app dependency installation.

The publish workflow takes this section verbatim as the GitHub Release
body and fails without it, so it lands before the tag. Drafted from the
19 commits since v1.8.7, then written for a user of the packages: the
two changes that ask something of them come first, preset lengths in
voxels and Generic_Rigid's affine.
@coderabbitai

coderabbitai Bot commented Nov 2, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

No actionable comments were generated in the recent review.

Recent review info
Run configuration
  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: Organization UI
  • Review profile: CHILL
  • Plan: Team
  • Run ID: b82d9bdd-456c-4b61-974f-ac2aa75a4a3b
Commits

Reviewing files that changed from the base of the PR and between ca16bcd and 36ef70e.

Files selected for processing: 1
  • CHANGELOG.md
Files skipped from review as they are similar to previous changes: 1
  • CHANGELOG.md

Included review availability: This review used your included allowance. 8 included reviews remain after this review. Your included PR review attempts over the past 7 days set your current allowance at 10 reviews per hour.

Walkthrough

The changelog adds v1.8.8 release notes dated 2026-11-02. It records breaking changes, features, and fixes.

Changes: v1.8.8 Release Notes

Layer / File(s) Summary
Breaking changes
CHANGELOG.md
The notes describe changes to preset length units, FireANTs learning rates, and Generic_Rigid transform output.
Features
CHANGELOG.md
The notes cover transform declarations and readers, 2-D and remote registration, initialization, workflow schemas, safetensors, and Python 3.14.
Fixes
CHANGELOG.md
The notes cover OME-Zarr fields and outputs, moved-image storage, multi-time-point input, resampling, and app requirement installation.

Estimated code review effort: 1 (Trivial) | ~3 minutes

Change: Other

Possibly related PRs

Merge Risk: Minimal · up to 36ef7

The release-note clarification addresses the identified ambiguity. No remaining issue prevents merging after normal checks.

Pre-merge checks: Passed 5
Check name Status Explanation
Title check Passed The title "ci: prepare v1.8.8 release" follows Conventional Commits and names the main change: preparing the v1.8.8 release. The changeset adds the v1.8.8 changelog entry only, with no runtime or pack…
Description check Passed The description covers the release-note purpose, base commit, validation steps, and the explicitly unrun perf-check. It omits the template's Type of change selection, the Related issues section, and t…
Docstring Coverage Passed No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentat…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Full details: Title check

Explanation

The title "ci: prepare v1.8.8 release" follows Conventional Commits and names the main change: preparing the v1.8.8 release. The changeset adds the v1.8.8 changelog entry only, with no runtime or package version changes, so the title is related to the change. It is not generic. It does not mention the release notes content, which is an acceptable level of detail. The title is slightly broad because the 'ci' type does not match a changelog-only commit exactly, but the title still describes the real change.

Full details: Description check

Explanation

The description covers the release-note purpose, base commit, validation steps, and the explicitly unrun perf-check. It omits the template's Type of change selection, the Related issues section, and the Breaking changes & migration section, even though the changelog documents breaking changes to preset length units and Generic_Rigid transform output. The How has this been tested section lists commands and observations, and the checklist items are not ticked. The description is mostly complete on substance but misses several template sections.

Resolution

Consider adding: (1) the Type of change selection (ci/build or chore), (2) a Related issues entry or deletion of that section, (3) a Breaking changes & migration section that summarizes the preset length unit and Generic_Rigid transform output changes, since the changelog documents them, and (4) the checklist state for pixi run check and the other test commands.

Full details: Docstring Coverage

Explanation

No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentation-only edits and deletions within surviving functions are included; unchanged diff context and fully deleted functions are excluded. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)

Finishing Touches
Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

A rabbit reads the release notes at dawn,
New transform shapes are carefully drawn.
Voxel steps and schemas appear,
Safetensors hop into gear.
OME-Zarr fields find their way,
The rabbit thumps: “Ship notes today!”

@coderabbitai coderabbitai Bot left a comment •

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • Fix comments: Fix CodeRabbit comments on this PR

Comment thread CHANGELOG.md Resolved
The writer declares the RFC-5 entry on an axis-aligned grid alone. RFC-5
places a field by a scale and a translation, so an oblique grid keeps its
rotation in a sidecar only KonfAI reads, which the release note implied
otherwise.

This branch has not been deployed

No deployments
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.

1 participant