Merge pull request #315 from bytecodealliance/ydnar/v0.6.1

all: prepare for v0.6.1

Author: ydnar

CHANGELOG.md

@@ -2,6 +2,12 @@
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [v0.6.1] — 2025-03-16
+
+### Changed
+
+- Updated package `cm` to [v0.2.1](https://github.com/bytecodealliance/go-modules/releases/tag/cm%2Fv0.2.1) with JSON fixes.
+
 ## [v0.6.0] — 2025-03-15
 
 ### Added
@@ -231,7 +237,8 @@ Initial version, supporting [TinyGo](https://tinygo.org/) + [WASI](https://wasi.
 - Because Go does not have a native tagged union type, pointers represented in `variant` and `result` types may not be visible to the garbage collector and may be freed while still in use.
 - Support for mainline [Go](https://go.dev/).
 
-[Unreleased]: <https://github.com/bytecodealliance/go-modules/compare/v0.6.0..HEAD>
+[Unreleased]: <https://github.com/bytecodealliance/go-modules/compare/v0.6.1..HEAD>
+[v0.6.1]: <https://github.com/bytecodealliance/go-modules/compare/v0.6.0..v0.6.1>
 [v0.6.0]: <https://github.com/bytecodealliance/go-modules/compare/v0.5.0..v0.6.0>
 [v0.5.0]: <https://github.com/bytecodealliance/go-modules/compare/v0.4.1..v0.5.0>
 [v0.4.1]: <https://github.com/bytecodealliance/go-modules/compare/v0.4.0..v0.4.1>

README.md

@@ -12,21 +12,17 @@ Package `wit/bindgen` contains code to generate Go bindings for [Component Model
 
 Package `cm` contains helper types and functions used by generated packages, such as `option<t>`, `result<ok, err>`, `variant`, `list`, and `resource`. These are intended for use by generated [Component Model](https://github.com/WebAssembly/component-model/blob/main/design/mvp/Explainer.md#type-definitions) bindings, where the caller converts to a Go equivalent. It attempts to map WIT semantics to their equivalent in Go where possible.
 
-#### Note on Memory Safety
-
-Package `cm` and generated bindings from `wit-bindgen-go` may have compatibility issues with the Go garbage collector, as they directly represent `variant` and `result` types as tagged unions where a pointer shape may be occupied by a non-pointer value. The GC may detect and throw an error if it detects a non-pointer value in an area it expects to see a pointer. This is an area of active development.
-
 ## `wit-bindgen-go`
 
 ### WIT → Go
 
-The `wit-bindgen-go` tool can generate Go bindings for WIT interfaces and worlds. If [`wasm-tools`](https://crates.io/crates/wasm-tools) is installed and in `$PATH`, then `wit-bindgen-go` can load WIT directly.
+`wit-bindgen-go` generates Go bindings for WIT interfaces and worlds. It generates a Go package for each WIT world and interface, with the necessary types, functions, methods, and ABI glue code. Generated code will depend on package `cm` for core Component Model types like `list<t>`.
 
 ```console
 wit-bindgen-go generate ../wasi-cli/wit
 ```
 
-Otherwise, pass the JSON representation of a fully-resolved WIT package:
+It also supports the [JSON representation](https://github.com/bytecodealliance/wasm-tools/pull/1203) of a fully-resolved WIT package:
 
 ```console
 wit-bindgen-go generate wasi-cli.wit.json
@@ -60,6 +56,10 @@ This will emit JSON on `stdout`, which can be piped to a file or another program
 wasm-tools component wit -j --all-features example.wit > example.wit.json
 ```
 
+## Memory Safety and Garbage Collection
+
+Package `cm` and generated bindings from `wit-bindgen-go` may have compatibility issues with the Go garbage collector. This is due to the memory representation of `variant` and `result` types as tagged unions where a pointer shape may be occupied by a non-pointer value. In Go (but not TinyGo), the GC may detect and throw an error if it detects a non-pointer value in an area it expects to see a pointer. This is an area of active development.
+
 ## License
 
 This project is licensed under the Apache 2.0 license with the LLVM exception. See [LICENSE](LICENSE) for more details.

go.mod

@@ -8,7 +8,7 @@ require (
 	github.com/sergi/go-diff v1.3.1
 	github.com/tetratelabs/wazero v1.9.0
 	github.com/urfave/cli/v3 v3.0.0-beta1
-	go.bytecodealliance.org/cm v0.2.0
+	go.bytecodealliance.org/cm v0.2.1
 	golang.org/x/mod v0.23.0
 	golang.org/x/tools v0.30.0
 )

go.sum

@@ -35,8 +35,8 @@ github.com/ulikunitz/xz v0.5.12 h1:37Nm15o69RwBkXM0J6A5OlE67RZTfzUxTj8fB3dfcsc=
 github.com/ulikunitz/xz v0.5.12/go.mod h1:nbz6k7qbPmH4IRqmfOplQw/tblSgqTqBwxkY0oWt/14=
 github.com/urfave/cli/v3 v3.0.0-beta1 h1:6DTaaUarcM0wX7qj5Hcvs+5Dm3dyUTBbEwIWAjcw9Zg=
 github.com/urfave/cli/v3 v3.0.0-beta1/go.mod h1:FnIeEMYu+ko8zP1F9Ypr3xkZMIDqW3DR92yUtY39q1Y=
-go.bytecodealliance.org/cm v0.2.0 h1:HMkj1x1LZWU/Ghu2TtUk3VTyS7gyDHLyIfIut0Cpc5M=
-go.bytecodealliance.org/cm v0.2.0/go.mod h1:JD5vtVNZv7sBoQQkvBvAAVKJPhR/bqBH7yYXTItMfZI=
+go.bytecodealliance.org/cm v0.2.1 h1:sFUQRPfM+ku7hKgFwxGdwjghv4QtTLukpqsAHgE1Tek=
+go.bytecodealliance.org/cm v0.2.1/go.mod h1:JD5vtVNZv7sBoQQkvBvAAVKJPhR/bqBH7yYXTItMfZI=
 golang.org/x/mod v0.23.0 h1:Zb7khfcRGKk+kqfxFaP5tZqCnDZMjC5VtUBs87Hr6QM=
 golang.org/x/mod v0.23.0/go.mod h1:6SkKJ3Xj0I0BrPOZoBy3bdMptDDU9oJrpohJ3eWZ1fY=
 golang.org/x/sync v0.11.0 h1:GGz8+XQP4FvTTrjZPzNKTMFtSXH80RAzG+5ghFPgK9w=