Skip to content

release: nir-rs 0.4.2 consumer README #39

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
rmems merged 4 commits into from
Aug 13, 2026
Merged

release: nir-rs 0.4.2 consumer README #39

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e19ed9e
docs: rewrite README for public crate consumers
rmems Aug 13, 2026
9400462
chore(release): bump nir-rs to 0.4.2
rmems Aug 13, 2026
ad63bfd
docs: clarify git install vs unreleased main
rmems Aug 13, 2026
7fd0325
chore(msrv): set package.rust-version to 1.97.1
rmems Aug 13, 2026
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
7 changes: 3 additions & 4 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,10 +51,9 @@ nightly fuzz harnesses: see [TESTING.md](TESTING.md) (`cargo +nightly fuzz run
`--all-features` enables `hdf5`, which links libhdf5: install `libhdf5-dev`
(Ubuntu) or `hdf5` (Homebrew) first.

**Toolchain:** CI and agents pin **Rust 1.97.1** (`rust-toolchain.toml`).
`package.rust-version` (**1.85.1**) is a cargo floor only — do **not** point the
OS matrix at an old rustc. Default/`serde` and `--all-features` tests run on
**Linux, macOS, and Windows** with `toolchain: "1.97.1"`.
**Toolchain:** **Rust 1.97.1** everywhere — `rust-toolchain.toml`,
`package.rust-version`, and CI (`toolchain: "1.97.1"`) on **Linux, macOS, and
Windows**. Keep those three in lockstep when the pin moves.

### Package / semver CI (release gate)

Expand Down
19 changes: 19 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,25 @@ for the **0.x** series as described under [Versioning](#versioning) below.

## [Unreleased]

## [0.4.2] - 2026-08-13

Docs-only patch so crates.io serves a consumer-facing README (0.4.1 is
immutable on the registry).

### Changed

- `package.rust-version` raised **1.85.1 → 1.97.1** to match the supported CI /
`rust-toolchain.toml` pin (stop advertising an untested older floor).

### Documentation

- Rewrite README for public consumers: drop internal sibling-crate roadmap,
Linear tracking, and CI-only Hub variable language; keep crates.io/docs.rs
install path, GHCR pulls, and scope clear without org-private context.
- Align crate rustdoc non-goals and a few comments with the same public wording.
- Bump advertised install / Docker tags to **0.4.2**.
- Toolchain docs: single **1.97.1** pin (no separate MSRV floor story).

## [0.4.1] - 2026-08-12

First **crates.io** release of the 0.4 line (package name `nir-rs`).
Expand Down
6 changes: 3 additions & 3 deletions COMPATIBILITY.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@ and what each release line claims.

| nir-rs line | Git tag / crates.io | Upstream NIR (fixtures) | Notes |
|-------------|---------------------|-------------------------|--------|
| **0.4.x** | `v0.4.1` / crates.io **0.4.1** | Vendored from neuromorphs/NIR @ `7883c3c` (see `tests/fixtures/README.md`) | Graph model + HDF5 I/O + serde DX + release hardening |
| **0.4.x** | `v0.4.2` / crates.io **0.4.2** | Vendored from neuromorphs/NIR @ `7883c3c` (see `tests/fixtures/README.md`) | Graph model + HDF5 I/O + serde DX + release hardening |
| 0.4.1 | crates.io **0.4.1** | Same fixture commit | First crates.io release; README still org-oriented |
| `v0.4.0` | git tag only (pre-crates.io) | Same fixture commit | First git-tagged consumer pin |

**Only fixture-backed claims are made.** A newer upstream NIR release is **not**
Expand Down Expand Up @@ -55,8 +56,7 @@ Default builds and default-feature CI need **no** Python and **no** libhdf5.

| Pin | Version | Role |
|-----|---------|------|
| Dev / CI | **1.97.1** | Quality bar (`rust-toolchain.toml`, GitHub Actions OS matrix) |
| `package.rust-version` | **1.85.1** | Cargo/crates.io floor (edition 2024 + `hdf5-metno` 0.14) |
| Dev / CI / `package.rust-version` | **1.97.1** | Same pin in `rust-toolchain.toml`, GitHub Actions, and crates.io metadata |

We do not matrix CI on the cargo floor. Raise the floor when dependencies or
language features require it; document the bump in the changelog.
Expand Down
2 changes: 1 addition & 1 deletion Cargo.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

10 changes: 4 additions & 6 deletions Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,10 @@
[package]
name = "nir-rs"
version = "0.4.1"
version = "0.4.2"
edition = "2024"
# Floor only (cargo/crates.io metadata). Edition 2024 needs ≥1.85.0; optional
# `hdf5` (hdf5-metno 0.14) needs ≥1.85.1. Day-to-day dev and CI pin **1.97.1**
# via rust-toolchain.toml / GitHub Actions — not this floor.
# Raise when deps or language features require it.
rust-version = "1.85.1"
# Supported toolchain — keep in lockstep with rust-toolchain.toml and CI
# (`toolchain: "1.97.1"`). Raise when the pin moves.
rust-version = "1.97.1"

@cubic-dev-ai cubic-dev-ai Bot Aug 13, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

P2: This docs-only 0.4.2 patch raises package.rust-version from 1.85.1 to 1.97.1, an MSRV bump that is a compatibility break for consumers still on 1.85.1–1.96.x. The PR is framed as "No API or wire changes" / a README refresh, but the bump means a plain cargo update to 0.4.2 now forces users to upgrade their toolchain. Per the project's own 0.x semver policy, an intentional floor raise should ride in a minor release (0.5.0), not a doc patch. Either bump the floor in a 0.5.0 cut or, if it must ship now, explicitly call out the MSRV break in the release notes rather than presenting the release as no-op.

Prompt for AI agents 
Check if this issue is valid — if so, understand the root cause and fix it. At Cargo.toml, line 7:

<comment>This docs-only 0.4.2 patch raises `package.rust-version` from 1.85.1 to 1.97.1, an MSRV bump that is a compatibility break for consumers still on 1.85.1–1.96.x. The PR is framed as "No API or wire changes" / a README refresh, but the bump means a plain `cargo update` to 0.4.2 now forces users to upgrade their toolchain. Per the project's own 0.x semver policy, an intentional floor raise should ride in a minor release (0.5.0), not a doc patch. Either bump the floor in a 0.5.0 cut or, if it must ship now, explicitly call out the MSRV break in the release notes rather than presenting the release as no-op.</comment>

<file context>
@@ -2,11 +2,9 @@
-rust-version = "1.85.1"
+# Supported toolchain — keep in lockstep with rust-toolchain.toml and CI
+# (`toolchain: "1.97.1"`). Raise when the pin moves.
+rust-version = "1.97.1"
 license = "MIT OR Apache-2.0"
 authors = ["Raul Montoya Cardenas <montoyaraul34@gmail.com>"]
</file context>

license = "MIT OR Apache-2.0"
authors = ["Raul Montoya Cardenas <montoyaraul34@gmail.com>"]
description = "Pure-Rust implementation of the Neuromorphic Intermediate Representation (NIR) — the standard interchange format for spiking neural networks."
Expand Down
Loading
Loading