Release docs - #71
Merged
Merged
Conversation
Add docs/RELEASE.md describing how to cut a new release: bump the crate version via a pull request, verify `main` is green, then push a `vX.Y.Z` tag to trigger the publish workflow, which runs CI, validates the tag against Cargo.toml, publishes to crates.io and creates a GitHub Release. Also covers prerequisites and troubleshooting for common failure modes. Signed-off-by: Jorge Prendes <jorge.prendes@gmail.com>
Update the pinned toolchain from 1.89.0 to 1.94.0. We deliberately stop at 1.94 rather than moving to a newer release because rustc 1.95+ dropped support for custom target specs via `--target <target-spec>.json`, which cargo-hyperlight relies on to build the `x86_64-hyperlight-none` target and its sysroot. Signed-off-by: Jorge Prendes <jorge.prendes@gmail.com>
Two unrelated CI problems, both surfaced by running the workflow locally with `act`. `setup-rust-toolchain` puts `-D warnings` in RUSTFLAGS by default. That is wrong for this repository: cargo-hyperlight builds third-party crates such as hyperlight-guest-capi and its dependencies by manifest path, so cargo treats them as local crates and does not apply `--cap-lints allow`. Any warning in those crates then fails the build, which is what broke `just build-c-guest` after the toolchain bump made two `unsafe` blocks in hyperlight-guest-tracing redundant. Opt out of the injected flag; `just fmt` and `just clippy` already pass `-D warnings` explicitly where it is wanted, so lint coverage is unchanged. The "Enable kvm" step also assumed a running udev daemon and failed outright on container-based runners. Probe for udev first and fall back to setting the mode of /dev/kvm directly when it is absent. Signed-off-by: Jorge Prendes <jorge.prendes@gmail.com>
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Add docs/RELEASE.md describing how to cut a new release: bump the crate version via a pull request, verify
mainis green, then push avX.Y.Ztag to trigger the publish workflow, which runs CI, validates the tag against Cargo.toml, publishes to crates.io and creates a GitHub Release.Also covers prerequisites and troubleshooting for common failure modes.