feat(go): creating remote package for reusable bindings

asteurer · asteurer · commit e81b3edc95f3 · 2026-01-04T15:11:41.000-06:00
Signed-off-by: Andrew Steurer &lt;94206073+asteurer@users.noreply.github.com&gt;
diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
@@ -59,6 +59,20 @@ jobs:
         EOF
       if: steps.tag.outputs.push_tag == 'yes'
 
+    - name: Push Go package tag
+      run: |
+        git_refs_url=$(jq .repository.git_refs_url $GITHUB_EVENT_PATH | tr -d '"' | sed 's/{\/sha}//g')
+        curl -iX POST $git_refs_url \
+          -H "Authorization: token ${{ secrets.GITHUB_TOKEN }}" \
+          -d @- << EOF
+        {
+          "ref": "refs/tags/crates/go/src/package/v${{ steps.tag.outputs.version }}",
+          "sha": "${{ steps.tag.outputs.sha }}"
+        }
+        EOF
+      if: steps.tag.outputs.push_tag == 'yes'
+
+
     - run: |
         sha=${{ github.sha }}
         run_id=$(
diff --git a/crates/go/src/lib.rs b/crates/go/src/lib.rs
diff --git a/crates/go/src/package/go.mod b/crates/go/src/package/go.mod
@@ -0,0 +1,3 @@
+module github.com/bytecodealliance/wit-bindgen
+
+go 1.25.5
diff --git a/crates/go/src/package/wit_async/wit_async.go b/crates/go/src/package/wit_async/wit_async.go
@@ -4,7 +4,8 @@ import (
 	"fmt"
 	"runtime"
 	"unsafe"
-	"wit_component/wit_runtime"
+
+	"github.com/bytecodealliance/wit-bindgen/wit_runtime"
 )
 
 const EVENT_NONE uint32 = 0
diff --git a/crates/go/src/package/wit_runtime/wit_runtime.go b/crates/go/src/package/wit_runtime/wit_runtime.go
diff --git a/crates/go/src/package/wit_types/wit_future.go b/crates/go/src/package/wit_types/wit_future.go
@@ -3,8 +3,9 @@ package wit_types
 import (
 	"runtime"
 	"unsafe"
-	"wit_component/wit_async"
-	"wit_component/wit_runtime"
+
+	"github.com/bytecodealliance/wit-bindgen/wit_async"
+	"github.com/bytecodealliance/wit-bindgen/wit_runtime"
 )
 
 type FutureVtable[T any] struct {
diff --git a/crates/go/src/package/wit_types/wit_option.go b/crates/go/src/package/wit_types/wit_option.go
diff --git a/crates/go/src/package/wit_types/wit_result.go b/crates/go/src/package/wit_types/wit_result.go
diff --git a/crates/go/src/package/wit_types/wit_stream.go b/crates/go/src/package/wit_types/wit_stream.go
@@ -3,8 +3,9 @@ package wit_types
 import (
 	"runtime"
 	"unsafe"
-	"wit_component/wit_async"
-	"wit_component/wit_runtime"
+
+	"github.com/bytecodealliance/wit-bindgen/wit_async"
+	"github.com/bytecodealliance/wit-bindgen/wit_runtime"
 )
 
 type StreamVtable[T any] struct {
diff --git a/crates/go/src/package/wit_types/wit_unit.go b/crates/go/src/package/wit_types/wit_unit.go
diff --git a/crates/test/src/go.rs b/crates/test/src/go.rs
@@ -37,11 +37,19 @@ impl LanguageMethods for Go {
     fn prepare(&self, runner: &mut Runner<'_>) -> Result<()> {
         let cwd = env::current_dir()?;
         let dir = cwd.join(&runner.opts.artifacts).join("go");
+        let bindings_dir = cwd.join("wit_component");
 
         super::write_if_different(&dir.join("test.go"), "package main\n\nfunc main() {}")?;
         super::write_if_different(&dir.join("go.mod"), "module test\n\ngo 1.25")?;
+        replace_go_mod(&bindings_dir)?;
 
         println!("Testing if `go build` works...");
+        runner.run_command(
+            Command::new("go")
+                .current_dir(&bindings_dir)
+                .arg("mod")
+                .arg("tidy"),
+        )?;
         runner.run_command(
             Command::new("go")
                 .current_dir(&dir)
@@ -74,9 +82,18 @@ impl LanguageMethods for Go {
                 .with_context(|| format!("unable to write `{}`", output.display()))?;
         }
 
+        replace_go_mod(compile.bindings_dir)?;
+
+        runner.run_command(
+            Command::new("go")
+                .current_dir(compile.bindings_dir)
+                .arg("mod")
+                .arg("tidy"),
+        )?;
+
         runner.run_command(
             Command::new("go")
-                .current_dir(&compile.bindings_dir)
+                .current_dir(compile.bindings_dir)
                 .env("GOOS", "wasip1")
                 .env("GOARCH", "wasm")
                 .arg("build")
@@ -92,9 +109,18 @@ impl LanguageMethods for Go {
     }
 
     fn verify(&self, runner: &Runner<'_>, verify: &Verify<'_>) -> Result<()> {
+        replace_go_mod(verify.bindings_dir)?;
+
         runner.run_command(
             Command::new("go")
-                .current_dir(&verify.bindings_dir)
+                .current_dir(verify.bindings_dir)
+                .arg("mod")
+                .arg("tidy"),
+        )?;
+
+        runner.run_command(
+            Command::new("go")
+                .current_dir(verify.bindings_dir)
                 .env("GOOS", "wasip1")
                 .env("GOARCH", "wasm")
                 .arg("build")
@@ -144,3 +170,17 @@ fn all_paths(path: &Path) -> Result<Vec<PathBuf>> {
     }
     Ok(paths)
 }
+
+fn replace_go_mod(bindings_dir: &Path) -> Result<()> {
+    let test_crate = PathBuf::from(env!("CARGO_MANIFEST_DIR"));
+    let wit_bindgen_root = test_crate.parent().unwrap().parent().unwrap();
+    let go_package_path = wit_bindgen_root.join("crates/go/src/package");
+
+    super::write_if_different(
+        &bindings_dir.join("go.mod"),
+        format!(
+            "module wit_component\n\ngo 1.25\n\nreplace github.com/bytecodealliance/wit-bindgen => {}",
+            go_package_path.display()
+        ),
+    ).map(|_| ())
+}
diff --git a/tests/runtime-async/async/incomplete-writes/test.go b/tests/runtime-async/async/incomplete-writes/test.go
@@ -3,7 +3,8 @@ package export_my_test_test_interface
 import (
 	"runtime"
 	. "wit_component/my_test_test_interface"
-	. "wit_component/wit_types"
+
+	. "github.com/bytecodealliance/wit-bindgen/wit_types"
 )
 
 type TestThing struct {
diff --git a/tests/runtime-async/async/ping-pong/runner.go b/tests/runtime-async/async/ping-pong/runner.go
@@ -3,7 +3,8 @@ package export_wit_world
 import (
 	"fmt"
 	test "wit_component/my_test_i"
-	"wit_component/wit_types"
+
+	"github.com/bytecodealliance/wit-bindgen/wit_types"
 )
 
 type Unit struct{}
diff --git a/tests/runtime-async/async/ping-pong/test.go b/tests/runtime-async/async/ping-pong/test.go
@@ -2,7 +2,8 @@ package export_my_test_i
 
 import (
 	"wit_component/my_test_i"
-	. "wit_component/wit_types"
+
+	. "github.com/bytecodealliance/wit-bindgen/wit_types"
 )
 
 func Ping(x *FutureReader[string], y string) *FutureReader[string] {
diff --git a/tests/runtime-async/async/simple-future/runner.go b/tests/runtime-async/async/simple-future/runner.go
@@ -2,7 +2,8 @@ package export_wit_world
 
 import (
 	test "wit_component/my_test_i"
-	"wit_component/wit_types"
+
+	"github.com/bytecodealliance/wit-bindgen/wit_types"
 )
 
 func Run() {
diff --git a/tests/runtime-async/async/simple-future/test.go b/tests/runtime-async/async/simple-future/test.go
@@ -1,6 +1,6 @@
 package export_my_test_i
 
-import . "wit_component/wit_types"
+import . "github.com/bytecodealliance/wit-bindgen/wit_types"
 
 func ReadFuture(x *FutureReader[Unit]) {
 	defer x.Drop()
diff --git a/tests/runtime-async/async/simple-stream-payload/test.go b/tests/runtime-async/async/simple-stream-payload/test.go
@@ -3,7 +3,8 @@ package export_my_test_i
 import (
 	"fmt"
 	"slices"
-	. "wit_component/wit_types"
+
+	. "github.com/bytecodealliance/wit-bindgen/wit_types"
 )
 
 func ReadStream(x *StreamReader[uint8]) {
diff --git a/tests/runtime-async/async/simple-stream/runner.go b/tests/runtime-async/async/simple-stream/runner.go
@@ -3,7 +3,8 @@ package export_wit_world
 import (
 	"fmt"
 	test "wit_component/my_test_i"
-	"wit_component/wit_types"
+
+	"github.com/bytecodealliance/wit-bindgen/wit_types"
 )
 
 func Run() {
diff --git a/tests/runtime-async/async/simple-stream/test.go b/tests/runtime-async/async/simple-stream/test.go
@@ -2,7 +2,8 @@ package export_my_test_i
 
 import (
 	"fmt"
-	. "wit_component/wit_types"
+
+	. "github.com/bytecodealliance/wit-bindgen/wit_types"
 )
 
 func ReadStream(x *StreamReader[Unit]) {
diff --git a/tests/runtime/flavorful/runner.go b/tests/runtime/flavorful/runner.go
@@ -4,7 +4,8 @@ import (
 	"fmt"
 	"slices"
 	test "wit_component/test_flavorful_to_test"
-	. "wit_component/wit_types"
+
+	. "github.com/bytecodealliance/wit-bindgen/wit_types"
 )
 
 func Run() {
diff --git a/tests/runtime/flavorful/test.go b/tests/runtime/flavorful/test.go
@@ -3,7 +3,8 @@ package export_test_flavorful_to_test
 import (
 	"slices"
 	. "wit_component/test_flavorful_to_test"
-	. "wit_component/wit_types"
+
+	. "github.com/bytecodealliance/wit-bindgen/wit_types"
 )
 
 func FListInRecord1(x ListInRecord1) {
diff --git a/tests/runtime/lists/runner.go b/tests/runtime/lists/runner.go
@@ -4,7 +4,8 @@ import (
 	"fmt"
 	"slices"
 	test "wit_component/test_lists_to_test"
-	. "wit_component/wit_types"
+
+	. "wit_component/local_wit_types"
 )
 
 func Run() {
diff --git a/tests/runtime/lists/test.go b/tests/runtime/lists/test.go
@@ -2,7 +2,8 @@ package export_test_lists_to_test
 
 import (
 	"slices"
-	. "wit_component/wit_types"
+
+	. "wit_component/local_wit_types"
 )
 
 func AllocatedBytes() uint32 {
diff --git a/tests/runtime/records/runner.go b/tests/runtime/records/runner.go
@@ -2,8 +2,8 @@ package export_wit_world
 
 import (
 	"fmt"
+	. "wit_component/local_wit_types"
 	test "wit_component/test_records_to_test"
-	. "wit_component/wit_types"
 )
 
 func Run() {
diff --git a/tests/runtime/records/test.go b/tests/runtime/records/test.go
@@ -2,14 +2,15 @@ package export_test_records_to_test
 
 import (
 	. "wit_component/test_records_to_test"
-	"wit_component/wit_types"
+
+	"wit_component/local_wit_types"
 )
 
 func MultipleResults() (uint8, uint16) {
 	return 4, 5
 }
 
-func SwapTuple(x wit_types.Tuple2[uint8, uint32]) (uint32, uint8) {
+func SwapTuple(x local_wit_types.Tuple2[uint8, uint32]) (uint32, uint8) {
 	return x.F1, x.F0
 }
 
@@ -29,6 +30,6 @@ func RoundtripRecord1(x R1) R1 {
 	return x
 }
 
-func Tuple1(x wit_types.Tuple1[uint8]) uint8 {
+func Tuple1(x local_wit_types.Tuple1[uint8]) uint8 {
 	return x.F0
 }
diff --git a/tests/runtime/resources/resources.go b/tests/runtime/resources/resources.go
@@ -4,7 +4,8 @@ import (
 	"fmt"
 	"runtime"
 	"wit_component/imports"
-	. "wit_component/wit_types"
+
+	. "github.com/bytecodealliance/wit-bindgen/wit_types"
 )
 
 func Add(a *Z, b *Z) *Z {
diff --git a/tests/runtime/results/intermediate.go b/tests/runtime/results/intermediate.go
@@ -2,7 +2,8 @@ package export_test_results_test
 
 import (
 	imports "wit_component/test_results_test"
-	. "wit_component/wit_types"
+
+	. "github.com/bytecodealliance/wit-bindgen/wit_types"
 )
 
 func StringError(x float32) Result[float32, string] {
diff --git a/tests/runtime/results/leaf.go b/tests/runtime/results/leaf.go
@@ -2,7 +2,8 @@ package export_test_results_test
 
 import (
 	. "wit_component/test_results_test"
-	. "wit_component/wit_types"
+
+	. "github.com/bytecodealliance/wit-bindgen/wit_types"
 )
 
 func StringError(x float32) Result[float32, string] {
diff --git a/tests/runtime/variants/runner.go b/tests/runtime/variants/runner.go
@@ -3,7 +3,8 @@ package export_wit_world
 import (
 	"fmt"
 	test "wit_component/test_variants_to_test"
-	. "wit_component/wit_types"
+
+	. "github.com/bytecodealliance/wit-bindgen/wit_types"
 )
 
 func Run() {
diff --git a/tests/runtime/variants/test.go b/tests/runtime/variants/test.go
@@ -2,7 +2,8 @@ package export_test_variants_to_test
 
 import (
 	. "wit_component/test_variants_to_test"
-	. "wit_component/wit_types"
+
+	. "github.com/bytecodealliance/wit-bindgen/wit_types"
 )
 
 func RoundtripOption(x Option[float32]) Option[uint8] {

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+module github.com/bytecodealliance/wit-bindgen`
	`2`	`+`
	`3`	`+go 1.25.5`
Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,8 @@ import (`
`4`	`4`	`"fmt"`
`5`	`5`	`"runtime"`
`6`	`6`	`"unsafe"`
`7`		`- "wit_component/wit_runtime"`
	`7`	`+`
	`8`	`+ "github.com/bytecodealliance/wit-bindgen/wit_runtime"`
`8`	`9`	`)`
`9`	`10`
`10`	`11`	`const EVENT_NONE uint32 = 0`