Skip to content

chore(release): bump pixi.toml version in release.sh - #24

Open
olantwin wants to merge 1 commit into
mainfrom
chore/release-bump-pixi
Open

chore(release): bump pixi.toml version in release.sh#24
olantwin wants to merge 1 commit into
mainfrom
chore/release-bump-pixi

Conversation

@olantwin

@olantwin olantwin commented Aug 12, 2026

Copy link
Copy Markdown
Contributor

What

Teach scripts/release.sh to bump the [package] version in pixi.toml alongside CMakeLists.txt and CITATION.cff, and stage it into the release commit.

Why

The script bumped CMakeLists.txt and CITATION.cff but never touched pixi.toml, so its [package] version drifted from the git tag — it sat at 0.2.0 through both the 0.3.0 and 0.4.0 releases and had to be corrected by hand when cutting v0.4.0. The pixi.toml comment already asks to keep this version in lockstep with the conda recipe; this makes the release script do it automatically.

Details

  • The substitution is anchored at column 0 (^version = "X.Y.Z"), so it only matches the top-level version key — not the inline version = fields of [package.build] / host-dependency tables.
  • The result is verified after substitution (mirroring the existing CMake check) and rolled back on failure.
  • Usage text updated to list the new step.

Testing

  • bash -n and shellcheck pass clean.
  • Dry-run sed against the current pixi.toml matches exactly one line (the [package] version).

Summary by CodeRabbit

  • Documentation
    • Release instructions now include updating the project version in pixi.toml.
  • Bug Fixes
    • Release validation now confirms the version format and safely restores release files if an update fails.
    • The project version is automatically included in the release commit when applicable.

@coderabbitai

coderabbitai Bot commented Aug 12, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 0edeaf7e-8157-4ea4-afbd-68990e6e4e9f

📥 Commits

Reviewing files that changed from the base of the PR and between 444ef8f and 7abc2d3.

📒 Files selected for processing (1)
  • scripts/release.sh
🚧 Files skipped from review as they are similar to previous changes (1)
  • scripts/release.sh

Included review availability: Your plan includes up to 1 review per rolling hour; 0 remain after this review.


📝 Walkthrough

Walkthrough

The release script now documents and performs top-level pixi.toml version updates. It validates the three-component version, restores release files on failure, and stages pixi.toml for the release commit.

Changes

Release version synchronization

Layer / File(s) Summary
Update and stage pixi.toml
scripts/release.sh
The release instructions include the pixi.toml version step. The script updates and validates the top-level three-component version, restores release files on validation failure, and stages pixi.toml for the release commit.

Estimated code review effort: 2 (Simple) | ~10 minutes

Merge Risk: ⚪ Minimal · up to 7abc2

This localized release-script change keeps the pixi.toml package version aligned during releases, with no actionable merge-blocking risk remaining after normal checks and review.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely describes the main change: updating the pixi.toml version in scripts/release.sh.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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.
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch chore/release-bump-pixi

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

The release script bumped CMakeLists.txt and CITATION.cff but left the
[package] version in pixi.toml untouched, so it drifted from the tag (it
sat at 0.2.0 through the 0.3.0 and 0.4.0 releases). Bump it in the same
release commit, keeping the source dependency and the conda recipe in
lockstep with the tag.

The substitution is anchored at column 0 so it only matches the top-level
version key, and is verified like the CMake bump. The block is guarded on
the presence of that key so the same snippet is a clean no-op in sibling
repos whose pixi.toml has no [package] section.

Assisted-by: claude-code:claude-opus-4-8[1m]
@olantwin

Copy link
Copy Markdown
Contributor Author

@coderabbitai review

@coderabbitai

coderabbitai Bot commented Aug 15, 2026

Copy link
Copy Markdown
✅ Action performed

Review finished.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

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