Skip to content

docs: add release information to README.md #273

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
MegaRedHand wants to merge 3 commits into
base: main
Choose a base branch
from
Open

docs: add release information to README.md #273

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f42310f
docs: add release information to readme
MegaRedHand Apr 10, 2026
71e8009
docs: update the release doc
MegaRedHand Apr 10, 2026
478b364
docs: add link to release doc on readme
MegaRedHand Apr 10, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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)
10 changes: 5 additions & 5 deletions RELEASE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
```

Expand Down
Loading