Skip to content

Commit c95afda

Browse files
authored
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 <simongdavies@users.noreply.github.com>
1 parent a594f0d commit c95afda

File tree

3 files changed

+13
-9
lines changed

3 files changed

+13
-9
lines changed

.github/workflows/CargoPublish.yml

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ jobs:
4545
VERSION="${{ github.ref }}"
4646
VERSION="${VERSION#refs/heads/release/v}"
4747
fi
48-
./dev/verify-version.sh "$VERSION" hyperlight-common hyperlight-guest hyperlight-guest-bin hyperlight-host
48+
./dev/verify-version.sh "$VERSION" hyperlight-common hyperlight-guest hyperlight-guest-bin hyperlight-host hyperlight-component-util hyperlight-component-macro
4949
5050
- name: Publish hyperlight-common
5151
continue-on-error: ${{ inputs.dry_run }}
@@ -64,13 +64,6 @@ jobs:
6464
run: cargo publish --manifest-path ./src/hyperlight_guest_bin/Cargo.toml ${{ inputs.dry_run && '--dry-run' || '' }}
6565
env:
6666
CARGO_REGISTRY_TOKEN: ${{ secrets.CARGO_PUBLISH_TOKEN }}
67-
68-
- name: Publish hyperlight-host
69-
continue-on-error: ${{ inputs.dry_run }}
70-
run: cargo publish --manifest-path ./src/hyperlight_host/Cargo.toml ${{ inputs.dry_run && '--dry-run' || '' }}
71-
env:
72-
CARGO_REGISTRY_TOKEN: ${{ secrets.CARGO_PUBLISH_TOKEN }}
73-
7467
- name: Publish hyperlight-component-util
7568
continue-on-error: ${{ inputs.dry_run }}
7669
run: cargo publish --manifest-path ./src/hyperlight_component_util/Cargo.toml ${{ inputs.dry_run && '--dry-run' || '' }}
@@ -82,6 +75,13 @@ jobs:
8275
run: cargo publish --manifest-path ./src/hyperlight_component_macro/Cargo.toml ${{ inputs.dry_run && '--dry-run' || '' }}
8376
env:
8477
CARGO_REGISTRY_TOKEN: ${{ secrets.CARGO_PUBLISH_TOKEN }}
78+
79+
- name: Publish hyperlight-host
80+
continue-on-error: ${{ inputs.dry_run }}
81+
run: cargo publish --manifest-path ./src/hyperlight_host/Cargo.toml ${{ inputs.dry_run && '--dry-run' || '' }}
82+
env:
83+
CARGO_REGISTRY_TOKEN: ${{ secrets.CARGO_PUBLISH_TOKEN }}
84+
8585

8686
# TODO: Do we want to publish hyperlight-guest-capi to crates.io given that it's not for Rust consumption?
8787
# - name: Publish hyperlight-guest-capi

src/hyperlight_guest/Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ homepage.workspace = true
88
repository.workspace = true
99
readme.workspace = true
1010
description = """
11-
Library to build guest applications for hyperlight.
11+
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.
1212
"""
1313

1414
[dependencies]

src/hyperlight_guest_bin/Cargo.toml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,10 @@ license.workspace = true
88
homepage.workspace = true
99
repository.workspace = true
1010
readme.workspace = true
11+
description = """
12+
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,
13+
and third-party code used by our C-API needed to build a native hyperlight-guest binary.
14+
"""
1115

1216
[features]
1317
default = ["libc", "printf"]

0 commit comments

Comments
 (0)