diff --git a/README.md b/README.md index 6284cecd..05da606f 100644 --- a/README.md +++ b/README.md @@ -91,6 +91,19 @@ Additional features: - [leanMetrics](docs/metrics.md) support for monitoring and observability - [lean-quickstart](https://github.com/blockblaz/lean-quickstart) integration for easier devnet running +### Container Releases + +Docker images are published to `ghcr.io/lambdaclass/ethlambda` with the following tags: + +| Tag | Description | +|-----|-------------| +| `devnetX` | Stable image for a specific devnet (e.g. `devnet3`) | +| `latest` | Alias for the stable image of the currently running devnet | +| `unstable` | Development builds; promoted to `devnetX`/`latest` once tested | +| `sha-XXXXXXX` | Specific commit | + +[`RELEASE.md`](./RELEASE.md) has more details on our release process and how to tag new images. + ### pq-devnet-3 We are running the [pq-devnet-3 spec](https://github.com/leanEthereum/pm/blob/main/breakout-rooms/leanConsensus/pq-interop/pq-devnet-3.md). A Docker tag `devnet3` is available for this version. @@ -112,3 +125,4 @@ Some features we are looking to implement in the near future, in order of priori - [Add support for pq-devnet-4](https://github.com/lambdaclass/ethlambda/issues/155) - [RPC endpoints for chain data consumption](https://github.com/lambdaclass/ethlambda/issues/75) - [Add guest program and ZK proving of the STF](https://github.com/lambdaclass/ethlambda/issues/156) +- [Formal verification of the STF](https://github.com/lambdaclass/ethlambda/issues/272) diff --git a/RELEASE.md b/RELEASE.md index e5044e69..185961a9 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -21,17 +21,17 @@ exact commit it was built from. On top of that, the workflow accepts a comma-separated list of custom tags as a parameter (e.g. `latest,devnet2`). We use the following tagging convention: -- `latest` - the latest image built from the `main` branch -- `devnet2` - the latest image built with `devnet2` support -- `devnet1` - *(deprecated)* `devnet1` support +- `unstable` - the latest image built from the `main` branch, without any devnet-specific features +- `latest` - the latest image built for the current devnet (`devnet3` at the time of writing) +- `devnetX` - the latest image built with `devnetX` support (e.g. `devnet3`, `devnet4`) Future devnets will introduce new tags, with previous ones left without updates. ### Pulling an image ```bash -docker pull ghcr.io/lambdaclass/ethlambda:latest # latest from main -docker pull ghcr.io/lambdaclass/ethlambda:devnet2 # devnet2-compatible +docker pull ghcr.io/lambdaclass/ethlambda:unstable # latest from main +docker pull ghcr.io/lambdaclass/ethlambda:devnet3 # devnet3-compatible docker pull ghcr.io/lambdaclass/ethlambda:sha-12f8377 # pinned to a specific commit ```