-
Notifications
You must be signed in to change notification settings - Fork 258
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Metadata for WASI OCI artifacts #608
Comments
Yes, we should definitely fill these in. I manually set the source repo label for all of these. For the license, we should set the SPDX ID as |
With the WASI 0.2.1 release, we now have these set for all WIT packages pushed to OCI. Check them out here: https://github.com/WebAssembly/WASI/releases/tag/v0.2.1 We set these on the oci push, here is an example for wasi:io cd preview2/io
wit build
export WASI_DESC="Wasi I/O is an API providing I/O stream abstractions. There are two types, input-stream, and output-stream, which support read and write, respectively, as well as a number of utility functions."
export WASI_PACK="io"
wkg oci push "ghcr.io/webassembly/wasi/$WASI_PACK:0.2.1" \
--annotation "org.opencontainers.image.description"=$WASI_DESC \
--annotation "org.opencontainers.image.source"="https://github.com/webassembly/wasi" \
--annotation "org.opencontainers.image.url"="https://wasi.dev" \
--annotation "org.opencontainers.image.version"="0.2.1" \
--annotation "org.opencontainers.image.licenses"="Apache-2.0 WITH LLVM-exception"
# to validate:
wkg oci pull "ghcr.io/webassembly/wasi/io:0.2.1"
wasm-tools component wit webassembly_wasi_io.wasm From an automation perspective, the following process once we have it, will simplify this:
Establishing this convention is tracked in WebAssembly/tool-conventions#230 |
I was looking today at the WASI OCI images we're publishing, and I noticed we're not yet making use of all of the capabilities ghcr has to offer. For example, the individual images we're publishing don't include descriptions or license data.
GitHub currently renders the following annotations, but even more annotations exist. If we applied what GitHub currently supports, we'd be adding the following keys to the Wasm OCI Artifact Layout:
Given the
annotations
section just covers metadata, and not anything else, maybe we should just reuse these? Unless there are plans to create our metadata specific to Wasm Components encoded as OCI Artifacts?The text was updated successfully, but these errors were encountered: