diff --git a/docs/runbook/README.md b/docs/runbook/README.md index 98baca98049..fda83351e40 100644 --- a/docs/runbook/README.md +++ b/docs/runbook/README.md @@ -20,4 +20,5 @@ This page gathers the available guides to operate a Mithril network. | **Create test Docker distribution** | [test-docker-distribution](./test-docker-distribution/README.md) | Create a custom test Docker distribution. | | **Deploy a test network manually** | [test-deploy-network](./test-deploy-network/README.md) | Manually deploy a test distribution to a test Mithril network. | | **Publish crates to crates.io manually** | [manual-publish-crates](./manual-publish-crates/README.md) | Manually publish Rust crates to crates.io. | -| **Publish packages to npm manually** | [manual-publish-npm](./manual-publish-npm/README.md) | Manually publish packages to npm registry. | \ No newline at end of file +| **Publish packages to npm manually** | [manual-publish-npm](./manual-publish-npm/README.md) | Manually publish packages to npm registry. | +| **Client multi-platform test** | [test-client-multiplatform](./test-client-multiplatform/README.md) | Run multi-platform client CLI binaries, docker and WASM package tests. | \ No newline at end of file diff --git a/docs/runbook/test-client-multiplatform/README.md b/docs/runbook/test-client-multiplatform/README.md new file mode 100644 index 00000000000..04f76158be2 --- /dev/null +++ b/docs/runbook/test-client-multiplatform/README.md @@ -0,0 +1,35 @@ +# Run Mithril client multi-platform test + +## Introduction + +You can manually run this workflow if you want to test the Mithril client features in the following contexts: +- Mithril client binaries on multi-platform (Ubuntu, MacOS and Windows) +- Mithril client docker image +- Mithril client WASM package with headless browsers (Chrome and Firefox) + +## Run the associated 'Mithril Client multi-platform test' GitHub Actions workflow + +Go to the page of the workflow with your browser: [Mithril Client multi-platform test](https://github.com/input-output-hk/mithril/actions/workflows/test-client.yml) + +Then, click on the **Run workflow** button: + +![Run workflow button](./img/run-workflow-button.png) + +Then fill the form to manually run the workflow: + +![Run workflow form](./img/run-workflow-form-png) + +> [!WARNING] +> - The **Mithril image id** of the distribution to deploy must be published on the [package registry](https://github.com/orgs/input-output-hk/packages?repo_name=mithril) + +> [!IMPORTANT] +> If you want to run the tests with an aggregator that has the signing capability for Cardano transactions, you will also need to provide a list of [Cardano transactions hashes](https://sancho.cexplorer.io/tx) separated by commas. +> +> The aggregator capabilities are available at the root route of the aggregator `/`: +> - [Capabilities for testing-preview aggregator](https://aggregator.testing-preview.api.mithril.network/aggregator) +> - [Capabilities for testing-sanchonet aggregator](https://aggregator.testing-sanchonet.api.mithril.network/aggregator) + + +The result should look like this in the GitHub Actions: + +![Run workflow result](./img/run-workflow-result.png) \ No newline at end of file diff --git a/docs/runbook/test-client-multiplatform/img/run-workflow-button.png b/docs/runbook/test-client-multiplatform/img/run-workflow-button.png new file mode 100644 index 00000000000..29dc4c19d90 Binary files /dev/null and b/docs/runbook/test-client-multiplatform/img/run-workflow-button.png differ diff --git a/docs/runbook/test-client-multiplatform/img/run-workflow-form.png b/docs/runbook/test-client-multiplatform/img/run-workflow-form.png new file mode 100644 index 00000000000..d965b470c8a Binary files /dev/null and b/docs/runbook/test-client-multiplatform/img/run-workflow-form.png differ diff --git a/docs/runbook/test-client-multiplatform/img/run-workflow-result.png b/docs/runbook/test-client-multiplatform/img/run-workflow-result.png new file mode 100644 index 00000000000..8a5aec561c7 Binary files /dev/null and b/docs/runbook/test-client-multiplatform/img/run-workflow-result.png differ