Skip to content

Commit d03ee24

Browse files
authored
Merge pull request #241 from vados-cosmonic/chore(examples)=add-wasm-tools-warning-to-all-examples
chore(examples): update warning and spread to all examples
2 parents a4f7c21 + 0968293 commit d03ee24

File tree

6 files changed

+48
-10
lines changed

6 files changed

+48
-10
lines changed

examples/component/http-client/README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,13 @@ The application...
1818

1919
## 📦 Dependencies
2020

21+
> [!WARNING]
22+
> Due to incompatibilities introduced in `wasm-tools` v1.226.0, a version of
23+
> `wasm-tools` <= 1.225.0 is **required** for running this example.
24+
>
25+
> You can install `wasm-tools` [v1.225.0 from upstream releases](https://github.com/bytecodealliance/wasm-tools/releases/tag/v1.225.0), or use
26+
> `cargo` ([Rust toolchain](https://doc.rust-lang.org/cargo/getting-started/installation.html)) -- (i.e. `cargo install --locked [email protected]`)
27+
2128
Before starting, ensure that you have the following installed in addition to the Go (1.23+) toolchain:
2229

2330
- [`tinygo`](https://tinygo.org/getting-started/install/) for compiling Go (always use the latest version)
@@ -111,4 +118,4 @@ pgrep -la ghcr_io
111118

112119
## 📖 Further reading
113120

114-
For more on building components, see the [Component Developer Guide](https://wasmcloud.com/docs/developer/components/) in the wasmCloud documentation.
121+
For more on building components, see the [Component Developer Guide](https://wasmcloud.com/docs/developer/components/) in the wasmCloud documentation.

examples/component/http-keyvalue-crud/README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,13 @@
44

55
## 📦 Dependencies
66

7+
> [!WARNING]
8+
> Due to incompatibilities introduced in `wasm-tools` v1.226.0, a version of
9+
> `wasm-tools` <= 1.225.0 is **required** for running this example.
10+
>
11+
> You can install `wasm-tools` [v1.225.0 from upstream releases](https://github.com/bytecodealliance/wasm-tools/releases/tag/v1.225.0), or use
12+
> `cargo` ([Rust toolchain](https://doc.rust-lang.org/cargo/getting-started/installation.html)) -- (i.e. `cargo install --locked [email protected]`)
13+
714
Before starting, ensure that you have the following installed in addition to the Go (1.23+) toolchain:
815

916
- [`tinygo`](https://tinygo.org/getting-started/install/) for compiling Go (always use the latest version)
@@ -96,4 +103,4 @@ You can stop the `wash dev` process with `Ctrl-C`.
96103

97104
When running this example with the `wash dev` command, wasmCloud uses its included NATS key-value store to back key-value operations, but the application could use another store like Redis with no change to the Go code.
98105

99-
You can learn more about capabilities like key-value storage are fulfilled by swappable providers in the [wasmCloud Quickstart](https://wasmcloud.com/docs/tour/hello-world).
106+
You can learn more about capabilities like key-value storage are fulfilled by swappable providers in the [wasmCloud Quickstart](https://wasmcloud.com/docs/tour/hello-world).

examples/component/http-password-checker/README.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Go HTTP Password Checker
22

3-
[This example](https://github.com/wasmCloud/go/tree/main/examples/component/http-password-checker) is a WebAssembly component that checks password strength over HTTP.
3+
[This example](https://github.com/wasmCloud/go/tree/main/examples/component/http-password-checker) is a WebAssembly component that checks password strength over HTTP.
44

55
The application...
66

@@ -17,6 +17,13 @@ The application...
1717

1818
## 📦 Dependencies
1919

20+
> [!WARNING]
21+
> Due to incompatibilities introduced in `wasm-tools` v1.226.0, a version of
22+
> `wasm-tools` <= 1.225.0 is **required** for running this example.
23+
>
24+
> You can install `wasm-tools` [v1.225.0 from upstream releases](https://github.com/bytecodealliance/wasm-tools/releases/tag/v1.225.0), or use
25+
> `cargo` ([Rust toolchain](https://doc.rust-lang.org/cargo/getting-started/installation.html)) -- (i.e. `cargo install --locked [email protected]`)
26+
2027
Before starting, ensure that you have the following installed in addition to the Go (1.23+) toolchain:
2128

2229
- [`tinygo`](https://tinygo.org/getting-started/install/) for compiling Go (always use the latest version)
@@ -25,7 +32,7 @@ Before starting, ensure that you have the following installed in addition to the
2532

2633
## 👟 Run the example
2734

28-
Clone the [wasmCloud/go repository](https://github.com/wasmcloud/go):
35+
Clone the [wasmCloud/go repository](https://github.com/wasmcloud/go):
2936

3037
```shell
3138
git clone https://github.com/wasmCloud/go.git
@@ -98,7 +105,7 @@ If `curl`ing produces...
98105
failed to invoke `wrpc:http/incoming-handler.handle`: failed to invoke `wrpc:http/[email protected]`: failed to shutdown synchronous parameter channel: not connected%
99106
```
100107

101-
...the HTTP server may not have finished starting up. You can check that the application has reached `Deployed` status with `wash app list`.
108+
...the HTTP server may not have finished starting up. You can check that the application has reached `Deployed` status with `wash app list`.
102109

103110
If the issue persists, you may have a lingering HTTP server provider running on your system. You can use `pgrep` to check:
104111

@@ -113,4 +120,4 @@ pgrep -la ghcr_io
113120

114121
To learn how to extend this example with additional capabilities, see the [Adding Capabilities](https://wasmcloud.com/docs/tour/adding-capabilities?lang=go) section of the wasmCloud documentation.
115122

116-
For more on building components, see the [Component Developer Guide](https://wasmcloud.com/docs/developer/components/) in the wasmCloud documentation.
123+
For more on building components, see the [Component Developer Guide](https://wasmcloud.com/docs/developer/components/) in the wasmCloud documentation.

examples/component/http-server/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,13 @@ The application...
1818

1919
## 📦 Dependencies
2020

21+
> [!WARNING]
22+
> Due to incompatibilities introduced in `wasm-tools` v1.226.0, a version of
23+
> `wasm-tools` <= 1.225.0 is **required** for running this example.
24+
>
25+
> You can install `wasm-tools` [v1.225.0 from upstream releases](https://github.com/bytecodealliance/wasm-tools/releases/tag/v1.225.0), or use
26+
> `cargo` ([Rust toolchain](https://doc.rust-lang.org/cargo/getting-started/installation.html)) -- (i.e. `cargo install --locked [email protected]`)
27+
2128
Before starting, ensure that you have the following installed in addition to the Go (1.23+) toolchain:
2229

2330
- [`tinygo`](https://tinygo.org/getting-started/install/) for compiling Go (always use the latest version)

examples/component/invoke/README.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Go Component SDK with Custom WIT
22

33
[This example](https://github.com/wasmCloud/go/tree/main/examples/component/invoke) is a WebAssembly component that demonstrates how to
4-
use the wasmCloud [Go Component SDK](https://github.com/wasmCloud/go/tree/main/component) in conjunction with your own custom [WIT interfaces](https://wasmcloud.com/docs/concepts/interfaces).
4+
use the wasmCloud [Go Component SDK](https://github.com/wasmCloud/go/tree/main/component) in conjunction with your own custom [WIT interfaces](https://wasmcloud.com/docs/concepts/interfaces).
55

66
You can find this application's custom interface in `wit/world.wit`:
77

@@ -13,6 +13,13 @@ interface invoker {
1313

1414
## 📦 Dependencies
1515

16+
> [!WARNING]
17+
> Due to incompatibilities introduced in `wasm-tools` v1.226.0, a version of
18+
> `wasm-tools` <= 1.225.0 is **required** for running this example.
19+
>
20+
> You can install `wasm-tools` [v1.225.0 from upstream releases](https://github.com/bytecodealliance/wasm-tools/releases/tag/v1.225.0), or use
21+
> `cargo` (Rust toolchain) if installed to install `1.225.0` -- (i.e. `cargo install --locked [email protected]`)
22+
1623
Before starting, ensure that you have the following installed in addition to the Go (1.23+) toolchain:
1724

1825
- [`tinygo`](https://tinygo.org/getting-started/install/) for compiling Go (always use the latest version)
@@ -21,7 +28,7 @@ Before starting, ensure that you have the following installed in addition to the
2128

2229
## 👟 Run the example
2330

24-
Clone the [wasmCloud/go repository](https://github.com/wasmcloud/go):
31+
Clone the [wasmCloud/go repository](https://github.com/wasmcloud/go):
2532

2633
```shell
2734
git clone https://github.com/wasmCloud/go.git
@@ -112,4 +119,4 @@ Hello from the invoker!
112119

113120
## 📖 Further reading
114121

115-
For more on custom interfaces, see the [Interface Developer Guide](https://wasmcloud.com/docs/developer/interfaces/creating-an-interface) in the wasmCloud documentation.
122+
For more on custom interfaces, see the [Interface Developer Guide](https://wasmcloud.com/docs/developer/interfaces/creating-an-interface) in the wasmCloud documentation.

examples/component/sqldb-postgres-query/README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,11 @@ The application...
1212
## 📦 Dependencies
1313

1414
> [!WARNING]
15-
> Due to incompatibilities introduced in `wasm-tools` v1.226.0, you must a version of
15+
> Due to incompatibilities introduced in `wasm-tools` v1.226.0, a version of
1616
> `wasm-tools` <= 1.225.0 is **required** for running this example.
17+
>
18+
> You can install `wasm-tools` [v1.225.0 from upstream releases](https://github.com/bytecodealliance/wasm-tools/releases/tag/v1.225.0), or use
19+
> `cargo` ([Rust toolchain](https://doc.rust-lang.org/cargo/getting-started/installation.html)) -- (i.e. `cargo install --locked [email protected]`)
1720
1821
Before starting, ensure that you have the following installed in addition to the Go (1.23+) toolchain:
1922

0 commit comments

Comments
 (0)