WebAssembly / WASI

WebAssembly System Interface
Other
4.71k stars 240 forks source link

Metadata for WASI OCI artifacts #608

Open yoshuawuyts opened 3 weeks ago

yoshuawuyts commented 3 weeks ago

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:

"annotations": {
   "org.opencontainers.image.description": "<description>",
   "org.opencontainers.image.source": "https://github.com/webassembly/<package>",
   "org.opencontainers.image.licenses": "<spdx license>"
}

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?

ricochet commented 2 weeks ago

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 Apache-2.0 WITH LLVM-exception. The WASI effort is under the W3C CLA, however we release software artifacts in the wasi-sdk with Apache-2.0 WITH LLVM-exception.