Skip to content
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.

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

Release v0.0.1 (take 5): Initial release of the compiler and SDK crates #279

Merged
merged 5 commits into from
Aug 26, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Runs `release-plz release` only after the release PR (starts with `release-plz-`)
# is merged to the main branch. See `release_always = false` in `release-plz.toml`
# is merged to the next branch. See `release_always = false` in `release-plz.toml`
# Publishes any unpublished crates when.
# Does nothing if all crates are already published (i.e. have their versions on crates.io).
# Does not create/update release PRs.
Expand All @@ -13,7 +13,7 @@ name: release-plz
on:
push:
branches:
- main
- next

env:
CARGO_MAKE_TOOLCHAIN: nightly-2024-05-07
Expand Down
9 changes: 4 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,7 @@ Install `release-plz` CLI tool following the instructions [here](https://release
The release process for the Miden Compiler and Miden SDK is managed using the `release-plz` tool. The following steps outline the process for creating a new release:

1. Run `release-plz update` in the repo root folder to update the compiler crates versions and generate changelogs.
2. Run `release-plz update` in the `sdk` folder to update the SDK crates versions and generate changelogs.
3. Create a release PR naming the branch with the `release-plz-` suffix (its important to use this suffix to trigger the crate publishing on CI in step 4).
4. Review the changes in the release PR, commit edits if needed and merge it into the main branch.
5. The CI will automatically run `release-plz release` after the release PR is merged to publish the new versions to crates.io.
6. Set a git tag for the published crates to mark the release.
2. Create a release PR naming the branch with the `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.
14 changes: 11 additions & 3 deletions Cargo.lock

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

9 changes: 5 additions & 4 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
resolver = "2"
members = [
"codegen/*",
"frontend-wasm",
"hir",
"hir-analysis",
"hir-macros",
Expand All @@ -13,12 +14,12 @@ members = [
"midenc-debug",
"midenc-driver",
"midenc-session",
"sdk/base-sys",
"sdk/*",
"tools/*",
"frontend-wasm",
"tests/integration",
]
exclude = [
"sdk/.cargo",
"tests/rust-apps/fib",
"tests/rust-apps-wasm",
"cargo-ext/tests/data",
Expand Down Expand Up @@ -85,7 +86,7 @@ midenc-codegen-masm = { path = "codegen/masm" }
miden-diagnostics = "0.1"
midenc-hir = { version = "0.0.1", path = "hir" }
midenc-hir-analysis = { version = "0.0.1", path = "hir-analysis" }
midenc-hir-macros = { version = "0.0.1", path = "hir-macros" }
midenc-hir-macros = { version = "0.0.2", path = "hir-macros" }
midenc-hir-symbol = { version = "0.0.1", path = "hir-symbol" }
midenc-hir-transform = { version = "0.0.1", path = "hir-transform" }
midenc-hir-type = { version = "0.0.1", path = "hir-type" }
Expand All @@ -94,7 +95,7 @@ midenc-frontend-wasm = { version = "0.0.1", path = "frontend-wasm" }
midenc-compile = { version = "0.0.1", path = "midenc-compile" }
midenc-driver = { version = "0.0.1", path = "midenc-driver" }
midenc-debug = { version = "0.0.1", path = "midenc-debug" }
midenc-session = { version = "0.0.1", path = "midenc-session" }
midenc-session = { version = "0.0.2", path = "midenc-session" }
miden-integration-tests = { version = "0.0.0", path = "tests/integration" }
wat = "1.0.69"
blake3 = "1.5"
Expand Down
8 changes: 8 additions & 0 deletions hir-macros/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased]

## [0.0.2](https://github.com/0xPolygonMiden/compiler/compare/midenc-hir-macros-v0.0.1...midenc-hir-macros-v0.0.2) - 2024-08-16

### Fixed
- *(cli)* improve help output, hide plumbing flags

### Other
- unify diagnostics infa between compiler, assembler, vm

## [0.0.1](https://github.com/0xPolygonMiden/compiler/compare/midenc-hir-macros-v0.0.0...midenc-hir-macros-v0.0.1) - 2024-07-25

### Other
Expand Down
2 changes: 1 addition & 1 deletion hir-macros/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[package]
name = "midenc-hir-macros"
description = "Provides proc macro support for Miden IR"
version = "0.0.1"
version = "0.0.2"
rust-version.workspace = true
authors.workspace = true
repository.workspace = true
Expand Down
21 changes: 21 additions & 0 deletions midenc-debug/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Changelog
All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]

## [0.0.1](https://github.com/0xPolygonMiden/compiler/compare/midenc-debug-v0.0.0...midenc-debug-v0.0.1) - 2024-08-16

### Other
- set `midenc-debug` version to `0.0.0` to be in sync with crates.io
- clean up naming in midenc-debug
- rename midenc-runner to midenc-debug
- fix typos ([#243](https://github.com/0xPolygonMiden/compiler/pull/243))
- a few minor improvements
- set up mdbook deploy
- add guides for compiling rust->masm
- add mdbook skeleton
- provide some initial usage instructions
- Initial commit
27 changes: 27 additions & 0 deletions midenc-session/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,33 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased]

## [0.0.2](https://github.com/0xPolygonMiden/compiler/compare/midenc-session-v0.0.1...midenc-session-v0.0.2) - 2024-08-16

### Added
- *(codegen)* propagate source spans from hir to masm

### Fixed
- add tx kernel library with stubs and link it on `-l miden`
- infer link libraries from target env
- tweak session init handling of outputs
- various tests, cli bugs, vm test executor, test builder api
- *(cli)* improve help output, hide plumbing flags
- clap error formatting, unused deps

### Other
- delete `miden-tx-kernel-sys` crate and move the code to `miden-base-sys`
- rename `midenc-tx-kernel` to `miden-base-sys` and move it to
- update to miden v0.10.3
- update to miden v0.10.2
- improve behavior of frontend config
- clean up driver init and output config
- fix various clippy warnings, bug in wasm br_table lowering, expect output
- move miden-vm deps to latest commit included in 0.10 releasef
- support compiled libraries, linker flags
- update to latest miden vm patchset
- unify diagnostics infa between compiler, assembler, vm
- unify compilation, rodata init, test harness

## [0.0.1](https://github.com/0xPolygonMiden/compiler/compare/midenc-session-v0.0.0...midenc-session-v0.0.1) - 2024-07-18

### Added
Expand Down
4 changes: 2 additions & 2 deletions midenc-session/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[package]
name = "midenc-session"
description = "Session management for the Midenc compiler"
version = "0.0.1"
version = "0.0.2"
rust-version.workspace = true
authors.workspace = true
repository.workspace = true
Expand All @@ -23,5 +23,5 @@ miden-stdlib.workspace = true
miden-diagnostics.workspace = true
midenc-hir-symbol.workspace = true
midenc-hir-macros.workspace = true
miden-base-sys = { version = "0.0.0", path = "../sdk/base-sys", features = ["masl-lib"] }
miden-base-sys = { version = "0.0.1", path = "../sdk/base-sys", features = ["masl-lib"] }
thiserror.workspace = true
24 changes: 24 additions & 0 deletions sdk/base-sys/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Changelog
All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]

## [0.0.1](https://github.com/0xPolygonMiden/compiler/compare/miden-base-sys-v0.0.0...miden-base-sys-v0.0.1) - 2024-08-16

### Fixed
- fix the build after VM v0.10.3 update

### Other
- delete `miden-tx-kernel-sys` crate and move the code to `miden-base-sys`
- build the MASL for the tx kernel stubs in `build.rs` and
- rename `midenc-tx-kernel` to `miden-base-sys` and move it to
- fix typos ([#243](https://github.com/0xPolygonMiden/compiler/pull/243))
- a few minor improvements
- set up mdbook deploy
- add guides for compiling rust->masm
- add mdbook skeleton
- provide some initial usage instructions
- Initial commit
4 changes: 2 additions & 2 deletions sdk/base-sys/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[package]
name = "miden-base-sys"
description = "Miden rollup Rust bingings and MASM library"
version = "0.0.0"
version = "0.0.1"
rust-version.workspace = true
authors.workspace = true
repository.workspace = true
Expand All @@ -26,4 +26,4 @@ default = []
# User facing Rust bindings
"bindings" = ["miden-stdlib-sys"]
# MASL library for Miden rollup (tx kernel, etc.) used by the compiler in the link phase
"masl-lib" = []
"masl-lib" = []
Loading