Merge pull request #123 from ydnar/ydnar/changelog

CHANGELOG: initial changelog

Author: ydnar

CHANGELOG.md

@@ -0,0 +1,17 @@
+# Changelog
+
+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.1.0] — 2024-07-04
+
+Initial version, supporting [TinyGo](https://tinygo.org/) + [WASI](https://wasi.dev) 0.2 (WASI Preview 2).
+
+### Known Issues
+- [#95](https://github.com/ydnar/wasm-tools-go/issues/95): `variant` and `result` types without fully-packed `data` shape types will not correctly represent all associated types.
+- [#111](https://github.com/ydnar/wasm-tools-go/issues/111): `flags` types with > 32 labels are not correctly supported. See [component-model#370](https://github.com/WebAssembly/component-model/issues/370) and [wasm-tools#1635](https://github.com/bytecodealliance/wasm-tools/pull/1635) for more information.
+- [#118](https://github.com/ydnar/wasm-tools-go/issues/118): Canonial ABI [post-return](https://github.com/WebAssembly/component-model/blob/main/design/mvp/CanonicalABI.md#canon-lift) functions to clean up allocations are not currently generated.
+- 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/ydnar/wasm-tools-go/compare/v0.1.0...HEAD>
+[v0.1.0]: <https://github.com/ydnar/wasm-tools-go/tree/v0.1.0>

design/README.md

@@ -4,14 +4,6 @@ This directory contains design notes and prototypes of Go bindings for Component
 
 ## Exports
 
-### Post-Return
-
-For each exported function that returns allocated memory, there is a [post-return](https://github.com/WebAssembly/component-model/blob/main/design/mvp/CanonicalABI.md#canon-lift) function called by the Canonical ABI machinery to allow the component to free the allocation(s).
-
-The post-return function name is `cabi_post_` followed by the fully-qualified function name. For example, the WIT function `example:foo/bar#echo` returning a `string` would have a post-return function named `cabi_post_example:foo/bar#echo`.
-
-The post-return function has the form of `(func (param flatten_functype($ft).results))`, where the arguments is a flattened representation of the function results.
-
 ### Export Bindings for Resource Types
 
 For each exported resource type, in addition to constructors, methods, and static functions, a component must import and export a number of functions to manage the resource lifecycle.
@@ -46,6 +38,16 @@ Similarly, a function is exported for each resource method (e.g. `drink` and `sp
 - Export: `example:foo/bar#[method]water.drink` (implemented by user code)
 - Export: `example:foo/bar#[method]water.spill` (implemented by user code)
 
+### Post-Return
+
+**Note: as of v0.1.0, this package does not support post-return functions.** See [#118](https://github.com/ydnar/wasm-tools-go/issues/118) for more information.
+
+For each exported function that returns allocated memory, there is a [post-return](https://github.com/WebAssembly/component-model/blob/main/design/mvp/CanonicalABI.md#canon-lift) function called by the Canonical ABI machinery to allow the component to free the allocation(s).
+
+The post-return function name is `cabi_post_` followed by the fully-qualified function name. For example, the WIT function `example:foo/bar#echo` returning a `string` would have a post-return function named `cabi_post_example:foo/bar#echo`.
+
+The post-return function has the form of `(func (param flatten_functype($ft).results))`, where the arguments is a flattened representation of the function results.
+
 ### Example in Go
 
 #### Generated Bindings