ci: Setup release-plz for pg-libs (#2032)

Adds the config for `release-plz` to generate release PRs for pg-libs
and push the crates to crates.io when merging it.

We will still need to do the first release manually before we can setup
trusted publishing.

Author: aborgna-q

.github/workflows/release-plz.yml

@@ -8,22 +8,24 @@ on:
 
 jobs:
   release-plz-pr:
-    name: Create release-plz PR
+    name: Create release PR (${{ matrix.component }})
     runs-on: ubuntu-latest
-    env:
-      HUGRENV_VERSION: "0.3.1"
-      HUGRENV_ROOT: "/tmp/hugrverse"
-      HUGRENV_PLATFORM: "manylinux_2_28_x86_64"
-      TKET_C_API_PATH: "/tmp/hugrverse"
-      LD_LIBRARY_PATH: "/tmp/hugrverse/lib:/tmp/hugrverse/lib64"
-      LLVM_SYS_211_PREFIX: "/tmp/hugrverse"
-
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - component: tket
+            config: release-plz-tket.toml
+            hugrenv: true
+          - component: pg-libs
+            config: release-plz-pg-libs.toml
+            hugrenv: false
     # Ensure only one release-plz tries to create a PR at a time.
     #
     # If two instances update the PR simultaneously, one will see an outdated git ref
     # and end up recreating the PR unnecessarily.
     concurrency:
-      group: ${{ github.workflow }}-${{ github.ref }}-pr
+      group: ${{ github.workflow }}-${{ github.ref }}-${{ matrix.component }}-pr
       cancel-in-progress: true
 
     steps:
@@ -34,24 +36,35 @@ jobs:
           token: ${{ secrets.HUGRBOT_PAT }}
       - name: Install Rust toolchain
         uses: dtolnay/rust-toolchain@stable
-      - name: Install LLVM
+      - name: Install tket and LLVM from hugrenv.lock
+        if: matrix.hugrenv
         uses: quantinuum/hugrverse-env/install-hugrenv-action@main
+        with:
+          packages: "tket,llvm"
 
       - name: Create release PR
-        uses: MarcoIeni/release-plz-action@v0.5
+        uses: release-plz/action@v0.5
         env:
           GITHUB_TOKEN: ${{ secrets.HUGRBOT_PAT }}
         with:
           command: release-pr
+          config: ${{ matrix.config }}
 
   # This job triggers the release to crates.io if the current crate version is higher than the
   # ones in the registry.
   #
-  # Release-plz will only run on commits originating from a PR whose source branch started with
-  # `release-plz-` (see `release-always=false` in the config).
+  # Each config publishes only after merging its own release PR.
   release-plz:
-    name: Release the crates
+    name: Release crates (${{ matrix.component }})
     runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - component: tket
+            config: release-plz-tket.toml
+          - component: pg-libs
+            config: release-plz-pg-libs.toml
     environment: crate-release
     permissions:
       id-token: write # Required for OIDC token exchange
@@ -64,13 +77,10 @@ jobs:
       - name: Install Rust toolchain
         uses: dtolnay/rust-toolchain@stable
 
-      - uses: rust-lang/crates-io-auth-action@v1
-        id: auth
-
       - name: Run release-plz
-        uses: MarcoIeni/release-plz-action@v0.5
+        uses: release-plz/action@v0.5
         env:
           GITHUB_TOKEN: ${{ secrets.HUGRBOT_PAT }}
-          CARGO_REGISTRY_TOKEN: ${{ steps.auth.outputs.token }}
         with:
           command: release
+          config: ${{ matrix.config }}

DEVELOPMENT.md

@@ -254,6 +254,18 @@ Rust releases are managed by `release-plz`. This tool will automatically detect
 breaking changes even when they are not marked as such in the commit message,
 and bump the version accordingly.
 
+Rust releases have two independent release PRs:
+
+- `release-plz-tket.toml` manages `tket` and `tket-qsystem`, with titles beginning
+  `chore(tket): release` and branches beginning `release-plz-tket-`.
+- `release-plz-pg-libs.toml` manages the publishable pg-libs crates, with titles
+  beginning `chore(pg-libs): release` and branches beginning `release-plz-pg-libs-`.
+  The `pg-ir-kernels-tests` harness is excluded.
+
+The release workflow uses the same group configuration for preparing the PR
+and publishing after it merges. For local commands, select the appropriate release group
+with `--config release-plz-<group>.toml`.
+
 To modify the version being released, update the `Cargo.toml`,
 `CHANGELOG.md`, PR name, and PR description in the release PR with the desired version. You may also have to update the dates.
 Rust pre-release versions should be formatted as `0.1.0-alpha.1` (or `-beta`, or `-rc`).

release-plz-pg-libs.toml

@@ -0,0 +1,103 @@
+# Release management for the pg-libs Rust crates.
+
+[workspace]
+# Open the release PR as a draft
+pr_draft = true
+pr_name = "chore(pg-libs): 🦀 release{% if package %} {{ package }}{% endif %}{% if version %} v{{ version }}{% endif %}"
+pr_branch_prefix = "release-plz-pg-libs-"
+
+# Default to not processing the packages
+release = false
+
+# Enforce adding the project name in the git tag, to avoid collisions with python.
+git_tag_name = "{{ package }}-v{{ version }}"
+git_release_name = "{{ package }}: v{{ version }}"
+pr_labels = ["X-release", "A-rust"]
+
+# Publish only after merging a PR whose branch starts with `release-plz-pg-libs-`.
+release_always = false
+
+# Include a list of contributors in the release body
+git_release_body = """
+{{ changelog }}
+{% if remote.contributors %}
+### Contributors
+{% for contributor in remote.contributors %}
+* @{{ contributor.username }}
+{% endfor %}
+{% endif %}
+"""
+
+[changelog]
+header = """# Changelog
+
+"""
+sort_commits = "oldest"
+
+commit_parsers = [
+    { message = "^feat", group = "New Features" },
+    { message = "^fix", group = "Bug Fixes" },
+    { message = "^docs", group = "Documentation" },
+    { message = "^style", group = "Styling" },
+    { message = "^refactor", group = "Refactor" },
+    { message = "^perf", group = "Performance" },
+    { message = "^test", group = "Testing" },
+    { message = "^chore", group = "Miscellaneous Tasks", skip = true },
+    { message = "^revert", group = "Reverted changes", skip = true },
+    { message = "^ci", group = "CI", skip = true },
+]
+
+[[package]]
+name = "tk-pg-libs"
+release = true
+version_group = "pg-libs"
+
+[[package]]
+name = "tk-pg-core"
+release = true
+version_group = "pg-libs"
+
+[[package]]
+name = "tk-pg-converter"
+release = true
+version_group = "pg-libs"
+
+[[package]]
+name = "tk-pg-bitpacked"
+release = true
+version_group = "pg-libs"
+
+[[package]]
+name = "tk-pg-ir-kernels"
+release = true
+version_group = "pg-libs"
+
+[[package]]
+name = "tk-pg-utils"
+release = true
+version_group = "pg-libs"
+
+[[package]]
+name = "tk-pg-canonical-form"
+release = true
+version_group = "pg-libs"
+
+[[package]]
+name = "tk-pg-optimize"
+release = true
+version_group = "pg-libs"
+
+[[package]]
+name = "tk-pg-greedy-synth"
+release = true
+version_group = "pg-libs"
+
+[[package]]
+name = "tk-pg-rebase"
+release = true
+version_group = "pg-libs"
+
+[[package]]
+name = "tk-pg-qm-tableau"
+release = true
+version_group = "pg-libs"

release-plz.toml release-plz-tket.tomlrelease-plz.toml renamed to release-plz-tket.toml

@@ -1,23 +1,20 @@
-# Automatic changelog generation for rust projects
+# Release management for the tket Rust crates.
 
 [workspace]
 # Open the release PR as a draft
 pr_draft = true
+pr_name = "chore(tket): 🦀 release{% if package %} {{ package }}{% endif %}{% if version %} v{{ version }}{% endif %}"
+pr_branch_prefix = "release-plz-tket-"
 
 # Default to not processing the packages
 release = false
 
 # Enforce adding the project name in the git tag, to avoid collisions with python.
-# (This would normally only be enabled once there are multiple packages in the workspace)
 git_tag_name = "{{ package }}-v{{ version }}"
 git_release_name = "{{ package }}: v{{ version }}"
 pr_labels = ["X-release", "A-rust"]
 
-# Only create releases / push to crates.io after merging a release-please PR.
-# This lets merge new crates to `main` without worrying about accidentally creating
-# github releases.
-#
-# To trigger a release manually, merge a PR from a branch starting with `release-plz-`.
+# Publish only after merging a PR whose branch starts with `release-plz-tket-`.
 release_always = false
 
 # Include a list of contributors in the release body