Merge pull request #184 from 0xPolygonMiden/greenhat/i142-ci-release

chore: setup release-plz on CI

.github/workflows/release.yml

@@ -0,0 +1,45 @@
+# Runs `release-plz release` only after the release PR is merged to the main branch 
+# see `release_always = false` in `release-plz.toml` 
+# Which publishes any unpublished crates.
+# Does nothing if all crates are already published (i.e. have their versions on crates.io).
+# Does not create/update release PRs.
+# The crate version bumping and changelog generation is done manually via the `release-plz release_pr` CLI command.
+# Which creates the PR with the proposed changes and when the PR is merged this action will publish the crates.
+name: release-plz
+
+on:
+  push:
+    branches:
+      - main
+
+env:
+  CARGO_MAKE_TOOLCHAIN: nightly-2024-03-10
+
+jobs:
+  release-plz:
+    name: release-plz
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Install Rust
+      uses: actions-rs/toolchain@v1
+      with:
+        toolchain: ${{ env.CARGO_MAKE_TOOLCHAIN }}
+        override: true
+    - name: Cache Cargo
+      uses: actions/cache@v2
+      with:
+        path: |
+          ~/.cargo/registry
+          ~/.cargo/git
+        key: ${{ github.workflow }}-${{ github.job }}-toolchain-${{ env.CARGO_MAKE_TOOLCHAIN }}
+    - name: Run release-plz
+      uses: MarcoIeni/[email protected]
+      with:
+        # Only run the `release` command. 
+        # The release PR is created manually via the `release-plz release_pr` CLI command.
+        # see https://release-plz.ieni.dev/docs/usage/release for more details
+        command: release
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        CARGO_REGISTRY_TOKEN: ${{ secrets.CARGO_REGISTRY_TOKEN }}

CONTRIBUTING.md

@@ -0,0 +1,25 @@
+# Contributing to Miden Compiler
+
+TBD
+
+## Release Process
+
+The release process for the Miden Compiler is managed using the `release-plz` tool. The following steps outline the process for creating a new release:
+
+1. Run `release-plz update` to update the crate versions and generate changelogs.
+2. Create a release PR naming the branch with `release-plz-` suffix (its important to use this suffix to trigger the crate publishing on CI in step 4).
+3. Review the changes in the release PR, commit edits if needed and merge it into the main branch.
+4. The CI will automatically run `release-plz release` after the release PR is merged to publish the new versions to crates.io.
+5. Set a git tag for the published crates to mark the release.
+
+### Prerequisites
+
+Install `release-plz` CLI tool following the instructions [here](https://release-plz.ieni.dev/docs/usage/installation)
+
+### Release of the Miden Cargo Extension
+
+Run the steps outlined above in the `Release Process` section in the repo root folder.
+
+### Release of the Miden SDK
+
+TBD

Cargo.toml

@@ -20,9 +20,9 @@ members = [
 exclude = ["tests/rust-apps-wasm", "cargo-ext/tests/data"]
 
 [workspace.package]
-version = "0.1.0"
+version = "0.0.0"
 rust-version = "1.73"
-authors = ["Miden Team"]
+authors = ["Miden contributors"]
 description = "An intermediate representation and compiler for Miden Assembly"
 repository = "https://github.com/0xPolygonMiden/compiler"
 homepage = "https://github.com/0xPolygonMiden/compiler"
@@ -71,7 +71,7 @@ miden-processor = { git = "https://github.com/0xPolygonMiden/miden-vm", rev = "d
 miden-stdlib = { git = "https://github.com/0xPolygonMiden/miden-vm", rev = "ddf536cd7157053f0940d7be41998b2a6546b4c1" }
 midenc-codegen-masm = { path = "codegen/masm" }
 miden-diagnostics = "0.1"
-midenc-hir= { path = "hir" }
+midenc-hir = { path = "hir" }
 midenc-hir-analysis = { path = "hir-analysis" }
 midenc-hir-macros = { path = "hir-macros" }
 midenc-hir-symbol = { path = "hir-symbol" }

codegen/masm/Cargo.toml

@@ -1,6 +1,7 @@
 [package]
 name = "midenc-codegen-masm"
-version.workspace = true
+description = "Miden Assembly backend for the Miden compiler"
+version = "0.0.0"
 rust-version.workspace = true
 authors.workspace = true
 repository.workspace = true

frontend-wasm/Cargo.toml

@@ -1,7 +1,7 @@
 [package]
 name = "midenc-frontend-wasm"
-description = "Build MidenIR from Wasm"
-version.workspace = true
+description = "Wasm frontend for the Miden compiler"
+version = "0.0.0"
 rust-version.workspace = true
 authors.workspace = true
 repository.workspace = true

hir-analysis/Cargo.toml

@@ -1,6 +1,7 @@
 [package]
 name = "midenc-hir-analysis"
-version.workspace = true
+description = "Analysis passes and utilties for Miden HIR"
+version = "0.0.0"
 rust-version.workspace = true
 authors.workspace = true
 repository.workspace = true

hir-macros/Cargo.toml

@@ -1,7 +1,7 @@
 [package]
 name = "midenc-hir-macros"
 description = "Provides proc macro support for Miden IR"
-version.workspace = true
+version = "0.0.0"
 rust-version.workspace = true
 authors.workspace = true
 repository.workspace = true

hir-symbol/Cargo.toml

@@ -1,6 +1,7 @@
 [package]
 name = "midenc-hir-symbol"
-version.workspace = true
+description = "String interning for the Miden compiler"
+version = "0.0.0"
 rust-version.workspace = true
 authors.workspace = true
 repository.workspace = true

hir-transform/Cargo.toml

@@ -1,6 +1,7 @@
 [package]
 name = "midenc-hir-transform"
-version.workspace = true
+description = "Transformation passes and utilities for Miden HIR"
+version = "0.0.0"
 rust-version.workspace = true
 authors.workspace = true
 repository.workspace = true

hir-type/Cargo.toml

@@ -1,6 +1,7 @@
 [package]
 name = "midenc-hir-type"
-version.workspace = true
+description = "Type system and utilities for Miden HIR"
+version = "0.0.0"
 rust-version.workspace = true
 authors.workspace = true
 repository.workspace = true

hir/Cargo.toml

@@ -1,6 +1,7 @@
 [package]
 name = "midenc-hir"
-version.workspace = true
+description = "High-level Intermediate Representation for Miden Assembly"
+version = "0.0.0"
 rust-version.workspace = true
 authors.workspace = true
 repository.workspace = true

midenc-compile/Cargo.toml

@@ -1,7 +1,7 @@
 [package]
 name = "midenc-compile"
 description = "The compiler frontend for Miden"
-version.workspace = true
+version = "0.0.0"
 rust-version.workspace = true
 authors.workspace = true
 repository.workspace = true

midenc-driver/Cargo.toml

@@ -1,7 +1,7 @@
 [package]
 name = "midenc-driver"
 description = "The driver for midenc, the Miden compiler"
-version.workspace = true
+version = "0.0.0"
 rust-version.workspace = true
 authors.workspace = true
 repository.workspace = true

midenc-session/Cargo.toml

@@ -1,6 +1,7 @@
 [package]
 name = "midenc-session"
-version.workspace = true
+description = "Session management for the Midenc compiler"
+version = "0.0.0"
 rust-version.workspace = true
 authors.workspace = true
 repository.workspace = true

midenc/Cargo.toml

@@ -1,7 +1,7 @@
 [package]
 name = "midenc"
 description = "The compiler frontend/executable for Miden"
-version.workspace = true
+version = "0.0.0"
 rust-version.workspace = true
 authors.workspace = true
 repository.workspace = true

release-plz.toml

@@ -0,0 +1,7 @@
+[workspace]
+# Only publish when the release PR is merged
+# https://release-plz.ieni.dev/docs/config#the-release_always-field
+release_always = false
+# Does not create a git tag
+# https://release-plz.ieni.dev/docs/config#the-git_tag_enable-field
+git_tag_enable = false

sdk/Cargo.toml

@@ -8,9 +8,9 @@ members = [
 
 [workspace.package]
 
-version = "0.1.0"
+version = "0.0.0"
 rust-version = "1.71"
-authors = ["Miden Team"]
+authors = ["Miden contributors"]
 repository = "https://github.com/0xPolygonMiden/compiler"
 homepage = "https://github.com/0xPolygonMiden/compiler"
 documentation = "https://github.com/0xPolygonMiden/compiler"

sdk/sdk/Cargo.toml

@@ -1,7 +1,7 @@
 [package]
 name = "miden-sdk"
 description = "Miden SDK"
-version.workspace = true
+version = "0.0.0"
 rust-version.workspace = true
 authors.workspace = true
 repository.workspace = true

sdk/stdlib-sys/Cargo.toml

@@ -1,7 +1,7 @@
 [package]
 name = "miden-stdlib-sys"
 description = "Low-level Rust bindings for the Miden standard library"
-version.workspace = true
+version = "0.0.0"
 rust-version.workspace = true
 authors.workspace = true
 repository.workspace = true