ci(release): publish crates and bloqade-ppvm in lockstep with release-plz

.cargo/config.toml

@@ -3,6 +3,11 @@
 [target.'cfg(target_arch = "x86_64")']
 rustflags = ["-C", "target-feature=+aes,+sse2"]
 
+# Same for aarch64 Linux, whose default target features lack AES (Apple
+# targets already enable it). Needed for the linux-aarch64 release wheel.
+[target.'cfg(all(target_arch = "aarch64", target_os = "linux"))']
+rustflags = ["-C", "target-feature=+aes,+neon"]
+
 # On wasm32 (browser) `getrandom` has no default entropy source. Select its JS
 # backend so `rand` (e.g. `rand::make_rng()` in the tableau simulators) reads
 # from the Web Crypto API. Pairs with the `getrandom`/`wasm_js` feature enabled

.github/workflows/release-plz.yml

@@ -0,0 +1,217 @@
+name: Release-plz
+
+# Lockstep release of the Rust crates (crates.io) and bloqade-ppvm (PyPI).
+#
+# On every push to main:
+#   - release-plz-pr opens/updates the release PR (version bump + CHANGELOG.md).
+#   - release-plz-release publishes any unpublished crate versions, then
+#     creates the `v0.x.y` tag and GitHub release (i.e. when the release PR
+#     is merged). If it released, the wheels are built, tested and published.
+# Run manually for a build-and-test dry run of the wheels; `publish_pypi`
+# (main only) also publishes the current version to PyPI.
+#
+# Auth: crates.io and PyPI both use OIDC trusted publishing (no tokens). The
+# PyPI publisher points at this file and the `pypi` environment.
+
+on:
+  push:
+    branches: [main]
+  workflow_dispatch:
+    inputs:
+      publish_pypi:
+        description: "Publish the current version to PyPI (main only)"
+        type: boolean
+        default: false
+
+permissions: {}
+
+env:
+  CARGO_TERM_COLOR: always
+
+jobs:
+  release-plz-release:
+    name: Release-plz release
+    if: ${{ github.event_name == 'push' }}
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write       # tags + GitHub release
+      pull-requests: read   # link merged PRs in the release notes
+      id-token: write       # crates.io trusted publishing
+    outputs:
+      releases_created: ${{ steps.release-plz.outputs.releases_created }}
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          persist-credentials: false
+      - uses: dtolnay/rust-toolchain@1.98.0
+      - uses: Swatinem/rust-cache@v2
+      - name: Run release-plz
+        id: release-plz
+        uses: release-plz/action@v0.5.139
+        with:
+          command: release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+  release-plz-pr:
+    name: Release-plz PR
+    if: ${{ github.event_name == 'push' }}
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      pull-requests: write
+    concurrency:
+      group: release-plz-${{ github.ref }}
+      cancel-in-progress: false
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          persist-credentials: false
+      - uses: dtolnay/rust-toolchain@1.98.0
+      - uses: Swatinem/rust-cache@v2
+      - name: Run release-plz
+        uses: release-plz/action@v0.5.139
+        with:
+          command: release-pr
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+  # One abi3 wheel per platform (pyo3 `abi3-py310`), so no Python matrix.
+  build:
+    name: Wheel (${{ matrix.target }})
+    needs: [release-plz-release]
+    if: >-
+      ${{ !cancelled() && (needs.release-plz-release.outputs.releases_created == 'true'
+      || github.event_name == 'workflow_dispatch') }}
+    permissions:
+      contents: read
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - os: ubuntu-latest
+            target: x86_64-unknown-linux-gnu
+          - os: ubuntu-latest
+            target: aarch64-unknown-linux-gnu
+          - os: macos-14
+            target: x86_64-apple-darwin
+          - os: macos-14
+            target: aarch64-apple-darwin
+          - os: windows-latest
+            target: x86_64-pc-windows-msvc
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      # manylinux_2_28 = glibc 2.28+ (RHEL 8 / Ubuntu 20.04+); ignored off Linux.
+      - name: Build wheel
+        uses: PyO3/maturin-action@v1
+        with:
+          working-directory: ppvm-python
+          target: ${{ matrix.target }}
+          args: --release --out dist
+          manylinux: "2_28"
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: wheel-${{ matrix.target }}
+          path: ppvm-python/dist/*.whl
+
+  sdist:
+    name: sdist
+    needs: [release-plz-release]
+    if: >-
+      ${{ !cancelled() && (needs.release-plz-release.outputs.releases_created == 'true'
+      || github.event_name == 'workflow_dispatch') }}
+    permissions:
+      contents: read
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Build sdist
+        uses: PyO3/maturin-action@v1
+        with:
+          working-directory: ppvm-python
+          command: sdist
+          args: --out dist
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: sdist
+          path: ppvm-python/dist/*.tar.gz
+
+  # Install each wheel into a clean env and run the Python test suite against
+  # it, so a broken wheel never reaches PyPI. The x86_64 macOS wheel is not
+  # tested: there is no native runner for it.
+  test:
+    name: Test (${{ matrix.target }}, py${{ matrix.python }})
+    needs: [build]
+    if: ${{ !cancelled() && needs.build.result == 'success' }}
+    permissions:
+      contents: read
+    strategy:
+      fail-fast: false
+      matrix:
+        python: ["3.10", "3.13"]
+        target:
+          - x86_64-unknown-linux-gnu
+          - aarch64-unknown-linux-gnu
+          - aarch64-apple-darwin
+          - x86_64-pc-windows-msvc
+        include:
+          - target: x86_64-unknown-linux-gnu
+            os: ubuntu-latest
+          - target: aarch64-unknown-linux-gnu
+            os: ubuntu-24.04-arm
+          - target: aarch64-apple-darwin
+            os: macos-14
+          - target: x86_64-pc-windows-msvc
+            os: windows-latest
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: astral-sh/setup-uv@v5
+
+      - uses: actions/download-artifact@v4
+        with:
+          name: wheel-${{ matrix.target }}
+          path: dist
+
+      # Run from outside ppvm-python/ so the src/ tree can't shadow the wheel.
+      - name: Run tests against the installed wheel
+        shell: bash
+        working-directory: ${{ runner.temp }}
+        run: >-
+          uv run --no-project --isolated --python ${{ matrix.python }}
+          --with "$(ls "$GITHUB_WORKSPACE"/dist/*.whl)"
+          --with pytest --with pytest-benchmark
+          pytest -p no:cacheprovider "$GITHUB_WORKSPACE/ppvm-python/test"
+
+  publish-to-pypi:
+    name: Publish to PyPI
+    needs: [release-plz-release, sdist, test]
+    if: >-
+      ${{ !cancelled() && needs.sdist.result == 'success' && needs.test.result == 'success'
+      && (needs.release-plz-release.outputs.releases_created == 'true'
+      || (inputs.publish_pypi && github.ref == 'refs/heads/main')) }}
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/bloqade-ppvm
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          path: dist
+          merge-multiple: true
+
+      - uses: pypa/gh-action-pypi-publish@release/v1

Cargo.toml

@@ -1,7 +1,9 @@
 [package]
 name = "ppvm"
-version = "0.1.0"
-edition = "2024"
+version.workspace = true
+edition.workspace = true
+# Examples-only package; not published.
+publish = false
 
 [dependencies]
 ppvm-pauli-sum = { version = "0.1.0", path = "crates/ppvm-pauli-sum" }
@@ -29,6 +31,14 @@ members = [
     "skills/ppvm-usage/examples/rust",
 ]
 
+# Single version for every crate and the `bloqade-ppvm` Python package
+# (via ppvm-python-native); bumped by release-plz.
+[workspace.package]
+version = "0.1.0"
+edition = "2024"
+license = "Apache-2.0"
+repository = "https://github.com/QuEraComputing/ppvm"
+
 # Keep function names and line numbers in release builds so profilers
 # (cargo-flamegraph, samply, Instruments) produce readable output. Adds
 # negligible binary bloat compared to full debug info.

crates/ppvm-cli/Cargo.toml

@@ -1,7 +1,10 @@
 [package]
 name = "ppvm-cli"
-version = "0.1.0"
-edition = "2024"
+version.workspace = true
+edition.workspace = true
+license.workspace = true
+repository.workspace = true
+description = "Command-line tool and TUI for parsing, running and stepping through ppvm `.sst` programs."
 
 [dependencies]
 clap = { version = "4.6.1", features = ["derive"] }

crates/ppvm-cli/LICENSE

@@ -0,0 +1 @@
+../../LICENSE

crates/ppvm-cli/NOTICE

@@ -0,0 +1 @@
+../../NOTICE

crates/ppvm-pauli-sum/Cargo.toml

@@ -1,7 +1,10 @@
 [package]
 name = "ppvm-pauli-sum"
-version = "0.1.0"
-edition = "2024"
+version.workspace = true
+edition.workspace = true
+license.workspace = true
+repository.workspace = true
+description = "Pauli-propagation engine for ppvm: `PauliSum`, truncation strategies and ready-made configs."
 
 [dependencies]
 ppvm-traits = { version = "0.1.0", path = "../ppvm-traits" }

crates/ppvm-pauli-sum/LICENSE

@@ -0,0 +1 @@
+../../LICENSE

crates/ppvm-pauli-sum/NOTICE

@@ -0,0 +1 @@
+../../NOTICE

crates/ppvm-pauli-word/Cargo.toml

@@ -1,7 +1,10 @@
 [package]
 name = "ppvm-pauli-word"
-version = "0.1.0"
-edition = "2024"
+version.workspace = true
+edition.workspace = true
+license.workspace = true
+repository.workspace = true
+description = "Packed Pauli-string types (plain, phased, lossy and pattern) for the ppvm simulators."
 
 [dependencies]
 ppvm-traits = { version = "0.1.0", path = "../ppvm-traits" }

crates/ppvm-pauli-word/LICENSE

@@ -0,0 +1 @@
+../../LICENSE

crates/ppvm-pauli-word/NOTICE

@@ -0,0 +1 @@
+../../NOTICE

crates/ppvm-python-native/Cargo.toml

@@ -1,7 +1,10 @@
 [package]
 name = "ppvm-python-native"
-version = "0.1.0"
-edition = "2024"
+version.workspace = true
+edition.workspace = true
+license.workspace = true
+repository.workspace = true
+publish = false
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 [lib]

crates/ppvm-stim/Cargo.toml

@@ -1,7 +1,10 @@
 [package]
 name = "ppvm-stim"
-version = "0.1.0"
-edition = "2024"
+version.workspace = true
+edition.workspace = true
+license.workspace = true
+repository.workspace = true
+description = "Parse and run Stim circuits on the ppvm generalized stabilizer tableau."
 
 [features]
 default = []

crates/ppvm-stim/LICENSE

@@ -0,0 +1 @@
+../../LICENSE

crates/ppvm-stim/NOTICE

@@ -0,0 +1 @@
+../../NOTICE

crates/ppvm-sym/Cargo.toml

@@ -1,7 +1,10 @@
 [package]
 name = "ppvm-sym"
-version = "0.1.0"
-edition = "2024"
+version.workspace = true
+edition.workspace = true
+license.workspace = true
+repository.workspace = true
+description = "Symbolic, parametric Pauli propagation for ppvm."
 
 [dependencies]
 anyhow = "1.0.100"

crates/ppvm-sym/LICENSE

@@ -0,0 +1 @@
+../../LICENSE

crates/ppvm-sym/NOTICE

@@ -0,0 +1 @@
+../../NOTICE

crates/ppvm-tableau-sum/Cargo.toml

@@ -1,7 +1,10 @@
 [package]
 name = "ppvm-tableau-sum"
-version = "0.1.0"
-edition = "2024"
+version.workspace = true
+edition.workspace = true
+license.workspace = true
+repository.workspace = true
+description = "Sums of generalized stabilizer tableaux with sampling, measurement and noise, for ppvm."
 
 [dependencies]
 bitvec = "1.0.1"

crates/ppvm-tableau-sum/LICENSE

@@ -0,0 +1 @@
+../../LICENSE

crates/ppvm-tableau-sum/NOTICE

@@ -0,0 +1 @@
+../../NOTICE

crates/ppvm-tableau/Cargo.toml

@@ -1,7 +1,10 @@
 [package]
 name = "ppvm-tableau"
-version = "0.1.0"
-edition = "2024"
+version.workspace = true
+edition.workspace = true
+license.workspace = true
+repository.workspace = true
+description = "Generalized stabilizer-tableau simulator for ppvm."
 
 [features]
 default = []

crates/ppvm-tableau/LICENSE

@@ -0,0 +1 @@
+../../LICENSE