Skip to content
This repository was archived by the owner on Nov 25, 2025. It is now read-only.

Document per-item versions using @since gates#114

Merged
yoshuawuyts merged 8 commits intoWebAssembly:mainfrom
yoshuawuyts:since-gates
Jul 16, 2024
Merged

Document per-item versions using @since gates#114
yoshuawuyts merged 8 commits intoWebAssembly:mainfrom
yoshuawuyts:since-gates

Conversation

@yoshuawuyts
Copy link
Member

Depends on WebAssembly/component-model#332 to be merged first. This documents the stability of all items using the @since gate notation, enabling WIT documents to be updated over time without major compatibility hazards.

While filing this patch I also saw there is a 0.3.0-draft document checked in. I wasn't sure what to do with that so I've omitted it from this PR for now. We should follow up on that later.

For an overview of how this would apply to all existing WASI APIs, including the unstable timezone API, see WebAssembly/WASI#604. Thanks!

@yoshuawuyts
Copy link
Member Author

If I try running wit-bindgen markdown wit --features= --html-in-md to resolve the CI failure, I get the following error:

thread 'main' panicked at /Users/yosh/.cargo/registry/src/index.crates.io-6f17d22bba15001f/wit-parser-0.209.1/src/resolve.rs:2105:21:
assertion `left == right` failed
  left: Interface { id: Id { idx: 1 }, stability: Stable { since: Version { major: 0, minor: 2, patch: 0 }, feature: None } }
 right: Interface { id: Id { idx: 1 }, stability: Unknown }
note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace

Not sure what's going on yet, but will have to dig in further.

@yoshuawuyts
Copy link
Member Author

bytecodealliance/wasm-tools#1669 seems to resolve the CI issue. That means in order to resolve this, we need to take the following steps:

@yoshuawuyts
Copy link
Member Author

Or actually, what perhaps just needs to happen is for us to merge the PR on wasi:cli, and then run wit-deps update again on this.

@yoshuawuyts yoshuawuyts merged commit d8a669d into WebAssembly:main Jul 16, 2024
@yoshuawuyts yoshuawuyts deleted the since-gates branch July 16, 2024 15:31
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants