Skip to content

Commit

Permalink
chore: add step to switch to the latest release tag before building t…
Browse files Browse the repository at this point in the history
…he `mithril-client` library
  • Loading branch information
dlachaume committed Nov 29, 2024
1 parent 69bce37 commit ba61457
Show file tree
Hide file tree
Showing 6 changed files with 29 additions and 5 deletions.
5 changes: 4 additions & 1 deletion examples/client-cardano-stake-distribution/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

This example shows how to implement a Mithril client and use the features related to the `Cardano stake distribution` type.

In this example, the client interacts by default with a real aggregator on the network `testing-preview` to:
In this example, the client interacts by default with a real aggregator on the network `release-preprod` to:

- list the available Cardano stake distributions
- get a single Cardano stake distribution
Expand All @@ -17,6 +17,9 @@ The crates [`slog`](https://docs.rs/slog/latest/slog/) and [`slog_term`](https:/
## Build and run the example

```bash
# Switch to the latest release tag
git checkout tags/$(curl -sSL https://api.github.com/repos/input-output-hk/mithril/releases/latest | jq -r '.tag_name')

# Build from the crate directory
cargo build

Expand Down
3 changes: 3 additions & 0 deletions examples/client-cardano-transaction/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,9 @@ In this example, the client interacts with an aggregator and performs the follow
## Build and run the example

```bash
# Switch to the latest release tag
git checkout tags/$(curl -sSL https://api.github.com/repos/input-output-hk/mithril/releases/latest | jq -r '.tag_name')

# Build from the crate directory
cargo build

Expand Down
5 changes: 4 additions & 1 deletion examples/client-mithril-stake-distribution/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

This example shows how to implement a Mithril client and use the features related to the `Mithril stake distribution` type.

In this example, the client interacts by default with a real aggregator on the network `testing-preview` to:
In this example, the client interacts by default with a real aggregator on the network `release-preprod` to:

- list the available Mithril stake distributions
- get a single Mithril stake distribution
Expand All @@ -17,6 +17,9 @@ The crates [`slog`](https://docs.rs/slog/latest/slog/) and [`slog_term`](https:/
## Build and run the example

```bash
# Switch to the latest release tag
git checkout tags/$(curl -sSL https://api.github.com/repos/input-output-hk/mithril/releases/latest | jq -r '.tag_name')

# Build from the crate directory
cargo build

Expand Down
5 changes: 4 additions & 1 deletion examples/client-snapshot/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

This example shows how to implement a Mithril client and use its features related to the `Snapshot` type.

In this example, the client interacts by default with a real aggregator on the network `testing-preview` to:
In this example, the client interacts by default with a real aggregator on the network `release-preprod` to:

- list the available snapshots
- get a single snapshot
Expand All @@ -19,6 +19,9 @@ The crate [indicatif](https://docs.rs/indicatif/latest/indicatif/) is used to ni
## Build and run the example

```bash
# Switch to the latest release tag
git checkout tags/$(curl -sSL https://api.github.com/repos/input-output-hk/mithril/releases/latest | jq -r '.tag_name')

# Build from the crate directory
cargo build

Expand Down
8 changes: 7 additions & 1 deletion examples/client-wasm-nodejs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,13 @@ In this example, the client interacts by default with a real aggregator on the n

## Build and run the example

First you need to compile the Mithril client Wasm library:
First you need to switch to the latest release tag:

```bash
git checkout tags/$(curl -sSL https://api.github.com/repos/input-output-hk/mithril/releases/latest | jq -r '.tag_name')
```

Compile the Mithril client Wasm library:

```bash
make -C ../../mithril-client-wasm build
Expand Down
8 changes: 7 additions & 1 deletion examples/client-wasm-web/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,13 @@ In this example, the client interacts by default with a real aggregator on the n

## Build and run the example

First you need to compile the Mithril client Wasm library:
First you need to switch to the latest release tag:

```bash
git checkout tags/$(curl -sSL https://api.github.com/repos/input-output-hk/mithril/releases/latest | jq -r '.tag_name')
```

Compile the Mithril client Wasm library:

```bash
make -C ../../mithril-client-wasm build
Expand Down

0 comments on commit ba61457

Please sign in to comment.