WebAssembly / WebAssembly/WASI

Best Practices for Versioning WIT Packages in WASI Proposals

Open
#583 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

S-inactive
Dominant language
Rust
Stars
5.8k
Forks
333
Avg merge
2d 13h
Merged PRs (30d)
3

Description

Hey there,

I am raising this issue to discuss whether or not we have a convention on naming WIT packages for WASI proposals, or should we have a convention for that?

With the launch of WASI 0.2, I observered that all WASI 0.2 proposals, including wasi:cli and wasi:http, are under the version v0.2.0. This approach is straightforward and understandable.

However, ambiguity arises with WIT packages in proposals that are at an early phase (1/0). The current practice seems to version these as v0.1.0, as seen in wasi-cloud-core's world.wit. This could potentially lead to confusion, implying a connection with WASI Preview 1 instead of indicating the package's development stage.

The aim of this issue is to discuss and establish best practices for versioning WIT packages in the context of WASI, especially for those not yet integrated into a preview release. Any recommendations would be greatly appreciated to ensure clarity and consistency across the ecosystem.

Thank you.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the linked wasi-cloud-core wit/world.wit example and compare it with the WASI 0.2 wasi:cli and wasi:http package versions mentioned in the issue. Done means the project has an agreed, clearly documented convention for versioning WIT packages in proposals that are not yet part of a preview release.

Written by the indexing model from the issue text.

Assessment

Tech stack
wasm
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.