feat: Version number in hugr binary format. #2468

zrho · 2025-07-24T10:10:08Z

This PR adds a (major, minor) version number to the binary hugr format and validates it on import.

codecov · 2025-07-24T10:14:08Z

Codecov Report

Attention: Patch coverage is 38.88889% with 110 lines in your changes missing coverage. Please review.

Project coverage is 82.27%. Comparing base (f615037) to head (796e968).
Report is 2 commits behind head on main.

Files with missing lines	Patch %	Lines
hugr-model/src/capnp/hugr_v0_capnp.rs	21.80%	103 Missing and 1 partial ⚠️
hugr-model/src/v0/binary/read.rs	61.53%	4 Missing and 1 partial ⚠️
hugr-model/src/version.rs	96.55%	0 Missing and 1 partial ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2468      +/-   ##
==========================================
- Coverage   82.39%   82.27%   -0.12%     
==========================================
  Files         248      250       +2     
  Lines       46339    46502     +163     
  Branches    41911    42071     +160     
==========================================
+ Hits        38180    38261      +81     
- Misses       6112     6191      +79     
- Partials     2047     2050       +3

Flag	Coverage Δ
python	`87.58% <ø> (-0.02%)`	⬇️
rust	`81.71% <38.88%> (-0.13%)`	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

hugr-model/capnp/hugr-v0.capnp

aborgna-q · 2025-07-24T10:22:11Z

hugr-model/src/v0/mod.rs

+/// The current major version of the `hugr-model` format.
+pub const VERSION_MAJOR: u32 = 0;
+
+/// The current minor version of the `hugr-model` format.
+pub const VERSION_MINOR: u32 = 0;
+


We should add the current version to the main crate doc, and explain the update/compatibility policy.

I'd also like to enforce we update the version in CI, so it would be better to have a single source of truth for these. Could we have a version.txt that get's include!d and parsed here?

Where should that version.txt live?

In the crate's root, along the Cargo.toml and README.md.

It should normally be included in the packaged crate, but you can check with cargo package --list to verify.

Perhaps a name like MODEL_VERSION may be more clear

It's now hugr_model::Version::current(). Alright with you?

aborgna-q

LGTM 👍

aborgna-q · 2025-07-24T12:55:19Z

hugr-model/src/version.rs

+                .trim()
+                .parse()


There's a const trim_ascii, but const u32::from_ascii is still in nightly u.u

This release fixes multiple inconsistencies between the serialization formats and improves the error messages when loading unsupported envelopes. We now also support nodes with up to `2^32` connections to the same port (up from `2^16`). --- ## 🤖 New release * `hugr-model`: 0.21.0 -> 0.22.0 (✓ API compatible changes) * `hugr-core`: 0.21.0 -> 0.22.0 (✓ API compatible changes) * `hugr-llvm`: 0.21.0 -> 0.22.0 (✓ API compatible changes) * `hugr-passes`: 0.21.0 -> 0.22.0 (✓ API compatible changes) * `hugr-persistent`: 0.1.0 -> 0.2.0 (✓ API compatible changes) * `hugr`: 0.21.0 -> 0.22.0 (✓ API compatible changes) * `hugr-cli`: 0.21.0 -> 0.22.0 (✓ API compatible changes) <details><summary>Changelog</summary> ## `hugr-model` <blockquote> ## [0.22.0](hugr-model-v0.21.0...hugr-model-v0.22.0) - 2025-07-24 ### New Features - Names of private functions become `core.title` metadata. ([#2448](#2448)) - include generator metatada in model import and cli validate errors ([#2452](#2452)) - Version number in hugr binary format. ([#2468](#2468)) - Use semver crate for -model version, and include in docs ([#2471](#2471)) </blockquote> ## `hugr-core` <blockquote> ## [0.22.0](hugr-core-v0.21.0...hugr-core-v0.22.0) - 2025-07-24 ### Bug Fixes - Ensure SumTypes have the same json encoding in -rs and -py ([#2465](#2465)) ### New Features - Export entrypoint metadata in Python and fix bug in import ([#2434](#2434)) - Names of private functions become `core.title` metadata. ([#2448](#2448)) - [**breaking**] Use binary envelopes for operation lower_func encoding ([#2447](#2447)) - [**breaking**] Update portgraph dependency to 0.15 ([#2455](#2455)) - Detect and fail on unrecognised envelope flags ([#2453](#2453)) - include generator metatada in model import and cli validate errors ([#2452](#2452)) - [**breaking**] Add `insert_region` to HugrMut ([#2463](#2463)) - Non-region entrypoints in `hugr-model`. ([#2467](#2467)) </blockquote> ## `hugr-llvm` <blockquote> ## [0.21.0](hugr-llvm-v0.20.2...hugr-llvm-v0.21.0) - 2025-07-09 ### New Features - [**breaking**] No nested FuncDefns (or AliasDefns) ([#2256](#2256)) - [**breaking**] Split `TypeArg::Sequence` into tuples and lists. ([#2140](#2140)) - [**breaking**] More helpful error messages in model import ([#2272](#2272)) - [**breaking**] Merge `TypeParam` and `TypeArg` into one `Term` type in Rust ([#2309](#2309)) - Add `MakeError` op ([#2377](#2377)) </blockquote> ## `hugr-passes` <blockquote> ## [0.22.0](hugr-passes-v0.21.0...hugr-passes-v0.22.0) - 2025-07-24 ### New Features - ReplaceTypes allows linearizing inside Op replacements ([#2435](#2435)) - Add pass for DFG inlining ([#2460](#2460)) </blockquote> ## `hugr-persistent` <blockquote> ## [0.2.0](hugr-persistent-v0.1.0...hugr-persistent-v0.2.0) - 2025-07-24 ### New Features - [**breaking**] Update portgraph dependency to 0.15 ([#2455](#2455)) </blockquote> ## `hugr` <blockquote> ## [0.22.0](hugr-v0.21.0...hugr-v0.22.0) - 2025-07-24 ### Bug Fixes - Ensure SumTypes have the same json encoding in -rs and -py ([#2465](#2465)) ### New Features - ReplaceTypes allows linearizing inside Op replacements ([#2435](#2435)) - Add pass for DFG inlining ([#2460](#2460)) - Export entrypoint metadata in Python and fix bug in import ([#2434](#2434)) - Names of private functions become `core.title` metadata. ([#2448](#2448)) - [**breaking**] Use binary envelopes for operation lower_func encoding ([#2447](#2447)) - [**breaking**] Update portgraph dependency to 0.15 ([#2455](#2455)) - Detect and fail on unrecognised envelope flags ([#2453](#2453)) - include generator metatada in model import and cli validate errors ([#2452](#2452)) - [**breaking**] Add `insert_region` to HugrMut ([#2463](#2463)) - Non-region entrypoints in `hugr-model`. ([#2467](#2467)) </blockquote> ## `hugr-cli` <blockquote> ## [0.22.0](hugr-cli-v0.21.0...hugr-cli-v0.22.0) - 2025-07-24 ### New Features - include generator metatada in model import and cli validate errors ([#2452](#2452)) </blockquote> </details> --- This PR was generated with [release-plz](https://github.com/release-plz/release-plz/). --------- Co-authored-by: Agustín Borgna <[email protected]>

## 🤖 New release * `hugr-model`: 0.22.0 -> 0.22.1 * `hugr-core`: 0.22.0 -> 0.22.1 * `hugr-llvm`: 0.22.0 -> 0.22.1 * `hugr-passes`: 0.22.0 -> 0.22.1 (✓ API compatible changes) * `hugr`: 0.22.0 -> 0.22.1 (✓ API compatible changes) * `hugr-cli`: 0.22.0 -> 0.22.1 * `hugr-persistent`: 0.2.0 -> 0.2.1 <details><summary>Changelog</summary> ## `hugr-model` <blockquote> ## [0.22.0](hugr-model-v0.21.0...hugr-model-v0.22.0) - 2025-07-24 ### New Features - Names of private functions become `core.title` metadata. ([#2448](#2448)) - include generator metatada in model import and cli validate errors ([#2452](#2452)) - Version number in hugr binary format. ([#2468](#2468)) - Use semver crate for -model version, and include in docs ([#2471](#2471)) </blockquote> ## `hugr-core` <blockquote> ## [0.22.0](hugr-core-v0.21.0...hugr-core-v0.22.0) - 2025-07-24 ### Bug Fixes - Ensure SumTypes have the same json encoding in -rs and -py ([#2465](#2465)) ### New Features - Export entrypoint metadata in Python and fix bug in import ([#2434](#2434)) - Names of private functions become `core.title` metadata. ([#2448](#2448)) - [**breaking**] Use binary envelopes for operation lower_func encoding ([#2447](#2447)) - [**breaking**] Update portgraph dependency to 0.15 ([#2455](#2455)) - Detect and fail on unrecognised envelope flags ([#2453](#2453)) - include generator metatada in model import and cli validate errors ([#2452](#2452)) - [**breaking**] Add `insert_region` to HugrMut ([#2463](#2463)) - Non-region entrypoints in `hugr-model`. ([#2467](#2467)) </blockquote> ## `hugr-llvm` <blockquote> ## [0.21.0](hugr-llvm-v0.20.2...hugr-llvm-v0.21.0) - 2025-07-09 ### New Features - [**breaking**] No nested FuncDefns (or AliasDefns) ([#2256](#2256)) - [**breaking**] Split `TypeArg::Sequence` into tuples and lists. ([#2140](#2140)) - [**breaking**] More helpful error messages in model import ([#2272](#2272)) - [**breaking**] Merge `TypeParam` and `TypeArg` into one `Term` type in Rust ([#2309](#2309)) - Add `MakeError` op ([#2377](#2377)) </blockquote> ## `hugr-passes` <blockquote> ## [0.22.1](hugr-passes-v0.22.0...hugr-passes-v0.22.1) - 2025-07-28 ### New Features - Include copy_discard_array in DelegatingLinearizer::default ([#2479](#2479)) - Inline calls to functions not on cycles in the call graph ([#2450](#2450)) </blockquote> ## `hugr` <blockquote> ## [0.22.1](hugr-v0.22.0...hugr-v0.22.1) - 2025-07-28 ### New Features - Include copy_discard_array in DelegatingLinearizer::default ([#2479](#2479)) - Inline calls to functions not on cycles in the call graph ([#2450](#2450)) </blockquote> ## `hugr-cli` <blockquote> ## [0.22.0](hugr-cli-v0.21.0...hugr-cli-v0.22.0) - 2025-07-24 ### New Features - include generator metatada in model import and cli validate errors ([#2452](#2452)) </blockquote> ## `hugr-persistent` <blockquote> ## [0.2.0](hugr-persistent-v0.1.0...hugr-persistent-v0.2.0) - 2025-07-24 ### New Features - [**breaking**] Update portgraph dependency to 0.15 ([#2455](#2455)) </blockquote> </details> --- This PR was generated with [release-plz](https://github.com/release-plz/release-plz/).

Version number in hugr binary format.

1b3898b

aborgna-q reviewed Jul 24, 2025

View reviewed changes

zrho added 3 commits July 24, 2025 12:48

FromStr for Version.

2b6ef2a

Extract Version into its own struct in capnp.

0ed53ce

Read version from version.txt.

796e968

zrho force-pushed the zrho/push-xrxlxuxkkkok branch from 2706693 to 796e968 Compare July 24, 2025 12:16

zrho marked this pull request as ready for review July 24, 2025 12:25

zrho requested a review from a team as a code owner July 24, 2025 12:25

zrho requested review from aborgna-q and doug-q and removed request for doug-q July 24, 2025 12:25

aborgna-q approved these changes Jul 24, 2025

View reviewed changes

aborgna-q linked an issue Jul 24, 2025 that may be closed by this pull request

Add version field to model #2451

Closed

zrho added this pull request to the merge queue Jul 24, 2025

Merged via the queue into main with commit 7d6931b Jul 24, 2025
25 of 26 checks passed

zrho deleted the zrho/push-xrxlxuxkkkok branch July 24, 2025 13:03

This was referenced Jul 24, 2025

chore: release #2443

Closed

chore: release #2470

Closed

chore: release #2476

Merged

zrho mentioned this pull request Jul 28, 2025

model version stored and reported in errors #2430

Closed

hugrbot mentioned this pull request Jul 28, 2025

chore: release #2483

Merged

This was referenced Jul 29, 2025

chore: release #2492

Closed

chore: release #2493

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat: Version number in hugr binary format. #2468

feat: Version number in hugr binary format. #2468

Uh oh!

zrho commented Jul 24, 2025

Uh oh!

codecov bot commented Jul 24, 2025 •

edited

Loading

Uh oh!

Uh oh!

aborgna-q Jul 24, 2025

Uh oh!

zrho Jul 24, 2025

Uh oh!

aborgna-q Jul 24, 2025 •

edited

Loading

Uh oh!

aborgna-q Jul 24, 2025

Uh oh!

zrho Jul 24, 2025

Uh oh!

aborgna-q left a comment

Uh oh!

aborgna-q Jul 24, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

feat: Version number in hugr binary format. #2468

feat: Version number in hugr binary format. #2468

Uh oh!

Conversation

zrho commented Jul 24, 2025

Uh oh!

codecov bot commented Jul 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

aborgna-q Jul 24, 2025

Choose a reason for hiding this comment

Uh oh!

zrho Jul 24, 2025

Choose a reason for hiding this comment

Uh oh!

aborgna-q Jul 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

aborgna-q Jul 24, 2025

Choose a reason for hiding this comment

Uh oh!

zrho Jul 24, 2025

Choose a reason for hiding this comment

Uh oh!

aborgna-q left a comment

Choose a reason for hiding this comment

Uh oh!

aborgna-q Jul 24, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

codecov bot commented Jul 24, 2025 •

edited

Loading

aborgna-q Jul 24, 2025 •

edited

Loading