Skip to content

Commit d280587

Browse files
committed
docs: add CI section in root README
1 parent 41695a2 commit d280587

File tree

2 files changed

+50
-2
lines changed

2 files changed

+50
-2
lines changed

README.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -357,6 +357,35 @@ More about the [SpiderMonkey runtime embedding](https://github.com/bytecodeallia
357357

358358
Coming.
359359

360+
## CI
361+
362+
### Testing
363+
364+
The `pluginlab` binary is built and tested e2e (using `rexpect` library).
365+
366+
The `web-host` is built and tested e2e (using [playwright](https://playwright.dev/)).
367+
368+
### Deployment
369+
370+
The `web-host` is automatically deployed to github pages when pushed on the `master` branch, containing the latest `wasm` versions of the plugins available at https://topheman.github.io/webassembly-component-model-experiments/plugins.
371+
372+
### Pre-release
373+
374+
https://github.com/topheman/webassembly-component-model-experiments/releases
375+
376+
When a git tag is pushed, a pre-release is prepared on github, linked to the tag, containing the `wasm` files for the plugins and the repl-logic, in order to version those. That way, you can use an old binary of `pluginlab` against the correct versions of the plugins:
377+
378+
```sh
379+
pluginlab\
380+
--repl-logic https://github.com/topheman/webassembly-component-model-experiments/releases/download/pluginlab@0.4.1/repl_logic_guest.wasm\
381+
--plugins https://github.com/topheman/webassembly-component-model-experiments/releases/download/pluginlab@0.4.1/plugin_greet.wasm\
382+
--plugins https://github.com/topheman/webassembly-component-model-experiments/releases/download/pluginlab@0.4.1/plugin_ls.wasm\
383+
--plugins https://github.com/topheman/webassembly-component-model-experiments/releases/download/pluginlab@0.4.1/plugin_echo.wasm\
384+
--plugins https://github.com/topheman/webassembly-component-model-experiments/releases/download/pluginlab@0.4.1/plugin_weather.wasm\
385+
--plugins https://github.com/topheman/webassembly-component-model-experiments/releases/download/pluginlab@0.4.1/plugin_cat.wasm\
386+
--plugins https://github.com/topheman/webassembly-component-model-experiments/releases/download/pluginlab@0.4.1/plugin-echo-c.wasm\
387+
--allow-all
388+
```
360389

361390
## Developer experience
362391

crates/pluginlab/README.md

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ cargo install pluginlab
5151

5252
## Usage
5353

54-
Run the CLI host, loading the plugins from the web (you can also load them from local files).
54+
Run the CLI host, loading the latest versions of the plugins from the web (you can also load them from local files).
5555

5656
```bash
5757
pluginlab\
@@ -75,7 +75,6 @@ Other flags:
7575
- `--help`: displays manual
7676
- `--debug`: run the host in debug mode (by default, the host runs in release mode)
7777

78-
7978
<details>
8079
<summary>🚀 Example of running the CLI host</summary>
8180
<pre>
@@ -124,3 +123,23 @@ Hello, Tophe!
124123
repl(0)>
125124
</pre>
126125
</details>
126+
127+
### Versioning
128+
129+
The plugins are also versioned in [github releases](https://github.com/topheman/webassembly-component-model-experiments/releases), you can use them if you want to use an old version of the plugins.
130+
131+
<summary>
132+
<details>
133+
<summary>Example of running the CLI host with old versions of the plugins (if you have an old version of <code>pluginlab</code></summary>
134+
<pre>
135+
pluginlab\
136+
--repl-logic https://github.com/topheman/webassembly-component-model-experiments/releases/download/pluginlab@0.4.1/repl_logic_guest.wasm\
137+
--plugins https://github.com/topheman/webassembly-component-model-experiments/releases/download/pluginlab@0.4.1/plugin_greet.wasm\
138+
--plugins https://github.com/topheman/webassembly-component-model-experiments/releases/download/pluginlab@0.4.1/plugin_ls.wasm\
139+
--plugins https://github.com/topheman/webassembly-component-model-experiments/releases/download/pluginlab@0.4.1/plugin_echo.wasm\
140+
--plugins https://github.com/topheman/webassembly-component-model-experiments/releases/download/pluginlab@0.4.1/plugin_weather.wasm\
141+
--plugins https://github.com/topheman/webassembly-component-model-experiments/releases/download/pluginlab@0.4.1/plugin_cat.wasm\
142+
--plugins https://github.com/topheman/webassembly-component-model-experiments/releases/download/pluginlab@0.4.1/plugin-echo-c.wasm\
143+
--allow-all
144+
</pre>
145+
</summary>

0 commit comments

Comments
 (0)