-
Notifications
You must be signed in to change notification settings - Fork 39
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
doc: add runbook for 'Mithril client multi-platform test'
- Loading branch information
Showing
5 changed files
with
37 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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) |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.