From 9aaef0852a9c04272ec9ff5ffe4d7f6843bffb12 Mon Sep 17 00:00:00 2001 From: Simon Davies Date: Mon, 9 Jun 2025 14:12:18 +0100 Subject: [PATCH] Update Crate descriptions for guest crates (#590) Add verification of crate versions for new crates to Crate Publish job Amend the order of crate publishing to account for dependencies Signed-off-by: Simon Davies --- .github/workflows/CargoPublish.yml | 16 ++++++++-------- src/hyperlight_guest/Cargo.toml | 2 +- src/hyperlight_guest_bin/Cargo.toml | 4 ++++ 3 files changed, 13 insertions(+), 9 deletions(-) diff --git a/.github/workflows/CargoPublish.yml b/.github/workflows/CargoPublish.yml index b97800910..146ed2b09 100644 --- a/.github/workflows/CargoPublish.yml +++ b/.github/workflows/CargoPublish.yml @@ -45,7 +45,7 @@ jobs: VERSION="${{ github.ref }}" VERSION="${VERSION#refs/heads/release/v}" fi - ./dev/verify-version.sh "$VERSION" hyperlight-common hyperlight-guest hyperlight-guest-bin hyperlight-host + ./dev/verify-version.sh "$VERSION" hyperlight-common hyperlight-guest hyperlight-guest-bin hyperlight-host hyperlight-component-util hyperlight-component-macro - name: Publish hyperlight-common continue-on-error: ${{ inputs.dry_run }} @@ -64,13 +64,6 @@ jobs: run: cargo publish --manifest-path ./src/hyperlight_guest_bin/Cargo.toml ${{ inputs.dry_run && '--dry-run' || '' }} env: CARGO_REGISTRY_TOKEN: ${{ secrets.CARGO_PUBLISH_TOKEN }} - - - name: Publish hyperlight-host - continue-on-error: ${{ inputs.dry_run }} - run: cargo publish --manifest-path ./src/hyperlight_host/Cargo.toml ${{ inputs.dry_run && '--dry-run' || '' }} - env: - CARGO_REGISTRY_TOKEN: ${{ secrets.CARGO_PUBLISH_TOKEN }} - - name: Publish hyperlight-component-util continue-on-error: ${{ inputs.dry_run }} run: cargo publish --manifest-path ./src/hyperlight_component_util/Cargo.toml ${{ inputs.dry_run && '--dry-run' || '' }} @@ -82,6 +75,13 @@ jobs: run: cargo publish --manifest-path ./src/hyperlight_component_macro/Cargo.toml ${{ inputs.dry_run && '--dry-run' || '' }} env: CARGO_REGISTRY_TOKEN: ${{ secrets.CARGO_PUBLISH_TOKEN }} + + - name: Publish hyperlight-host + continue-on-error: ${{ inputs.dry_run }} + run: cargo publish --manifest-path ./src/hyperlight_host/Cargo.toml ${{ inputs.dry_run && '--dry-run' || '' }} + env: + CARGO_REGISTRY_TOKEN: ${{ secrets.CARGO_PUBLISH_TOKEN }} + # TODO: Do we want to publish hyperlight-guest-capi to crates.io given that it's not for Rust consumption? # - name: Publish hyperlight-guest-capi diff --git a/src/hyperlight_guest/Cargo.toml b/src/hyperlight_guest/Cargo.toml index 7178cfa10..8fce35293 100644 --- a/src/hyperlight_guest/Cargo.toml +++ b/src/hyperlight_guest/Cargo.toml @@ -8,7 +8,7 @@ homepage.workspace = true repository.workspace = true readme.workspace = true description = """ -Library to build guest applications for hyperlight. +Provides only the essential building blocks for interacting with the host environment, including the VM exit mechanism, abstractions for calling host functions and receiving return values, and the input/output stacks used for guest-host communication. """ [dependencies] diff --git a/src/hyperlight_guest_bin/Cargo.toml b/src/hyperlight_guest_bin/Cargo.toml index 10038211f..1b8202f51 100644 --- a/src/hyperlight_guest_bin/Cargo.toml +++ b/src/hyperlight_guest_bin/Cargo.toml @@ -8,6 +8,10 @@ license.workspace = true homepage.workspace = true repository.workspace = true readme.workspace = true +description = """ +This crate provides the opinionated bits of the guest library, such as the panic handler, the entry point, the guest logger, the exception handling logic, +and third-party code used by our C-API needed to build a native hyperlight-guest binary. +""" [features] default = ["libc", "printf"]