chore: revamp the release process automation #735
Draft
+154
−36
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The new release process will be the following: Release of the Miden Compiler 1. Merging to `main` will create a new release PR containing any unreleased changes. 2. Optional. Change the proposed crate version, CHANGELOG edits. 3. The release PR gets merged to `main` when we are ready to publish the release. 4. The crates are published to crates.io, a new git tag is created, as well as a GitHub release 5. A job is run to pre-build the executable for our supported targets and upload them to the created Github release. 6. Merge the `main` branch back to the `next` branch. Release of the Miden SDK crates 1. Create a release PR naming the branch with the `release-plz-` prefix (its important to use this prefix to trigger the crate publishing on CI in one of the next steps). 2. Bump the SDK crates versions and update the CHANGELOG. 3. 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. 6. Make a Github release. 7. Merge the `main` branch back to the `next` branch. Implementation details: 1. Suppress git tag and github release creation for all the crates except `midenc` and `miden`(SDK). 2. In `uploading-artifacts` CI job find the release tags for `midenc` (to ignore SDK release).
|
@bitwalker The new CI jobs need write permission. I don't have access to manage those. Could you check if you can set those? |
bitwalker
reviewed
Nov 2, 2025
bitwalker
approved these changes
Nov 2, 2025
I'd like to wait for the automated bindings generation. Without it, the manual bindings writing process involves changes to the frontend (MASM signature, transformation strategy, etc.) for every function. So it'd be painful to do it in two repos simultaneously. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Close #726
The new release process will be the following:
Release of the Miden Compiler
mainwill create a new release PR containing any unreleased changes.mainwhen we are ready to publish the release.mainbranch back to thenextbranch.Release of the Miden SDK crates
release-plz-prefix (its important to use this prefix to trigger the crate publishing on CI in one of the next steps).release-plz releaseafter the release PR is merged to publish the new versions to crates.io.mainbranch back to thenextbranch.Implementation details:
midencandmiden(SDK).uploading-artifactsCI job find the release tags formidenc(to ignore SDK release).