-
Notifications
You must be signed in to change notification settings - Fork 22
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #184 from 0xPolygonMiden/greenhat/i142-ci-release
chore: setup release-plz on CI
- Loading branch information
Showing
29 changed files
with
136 additions
and
51 deletions.
There are no files selected for viewing
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 }} |
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains 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
This file contains 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
This file contains 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
This file contains 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
This file contains 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
This file contains 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
This file contains 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
This file contains 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
This file contains 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
This file contains 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
This file contains 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
This file contains 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
This file contains 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
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains 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
This file contains 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
This file contains 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
Oops, something went wrong.