Skip to content

Commit 1285391

Browse files
authored
docs: clarify image tag descriptions (#498)
## Summary Clarifies the Docker image-tag wording in `README.md` and `RELEASE.md`: - `unstable` is built from the latest `main` commit. - `latest` / `devnetX` are the latest **stable** devnet images. - Bumped the stale `devnet3` "at the time of writing" and `docker pull` examples to `devnet5` (the current devnet). ## Notes - Left untouched: `Cargo.toml` `leansig` `devnet4` branch (real dependency), the `devnet3/devnet4` test-ignore comment in `encoding.rs`, and the README "Older devnets" list (`devnet1-4` are correctly the *older* ones; `devnet5` is current). - The new `docs/spec_deviations.md` page (and its `SUMMARY.md` index entry) was split into #499.
1 parent 8437c00 commit 1285391

2 files changed

Lines changed: 6 additions & 6 deletions

File tree

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -114,8 +114,8 @@ Docker images are published to `ghcr.io/lambdaclass/ethlambda` with the followin
114114
| Tag | Description |
115115
|-----|-------------|
116116
| `devnetX` | Stable image for a specific devnet (e.g. `devnet4`) |
117-
| `latest` | Alias for the stable image of the currently running devnet |
118-
| `unstable` | Development builds; promoted to `devnetX`/`latest` once tested |
117+
| `latest` | Alias for the latest stable image of the currently running devnet |
118+
| `unstable` | Built from the latest main commit; promoted to `devnetX`/`latest` once tested |
119119
| `sha-XXXXXXX` | Specific commit |
120120
121121
[`RELEASE.md`](./RELEASE.md) has more details on our release process and how to tag new images.

RELEASE.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,17 +21,17 @@ exact commit it was built from.
2121
On top of that, the workflow accepts a comma-separated list of custom tags as a
2222
parameter (e.g. `latest,devnet2`). We use the following tagging convention:
2323

24-
- `unstable` - the latest image built from the `main` branch, without any devnet-specific features
25-
- `latest` - the latest image built for the current devnet (`devnet3` at the time of writing)
26-
- `devnetX` - the latest image built with `devnetX` support (e.g. `devnet3`, `devnet4`)
24+
- `unstable` - the latest image built from the `main` branch
25+
- `latest` - the latest stable image built for the current devnet (`devnet5` at the time of writing)
26+
- `devnetX` - the latest stable image built with `devnetX` support (e.g. `devnet4`, `devnet5`)
2727

2828
Future devnets will introduce new tags, with previous ones left without updates.
2929

3030
### Pulling an image
3131

3232
```bash
3333
docker pull ghcr.io/lambdaclass/ethlambda:unstable # latest from main
34-
docker pull ghcr.io/lambdaclass/ethlambda:devnet3 # devnet3-compatible
34+
docker pull ghcr.io/lambdaclass/ethlambda:devnet5 # devnet5-compatible
3535
docker pull ghcr.io/lambdaclass/ethlambda:sha-12f8377 # pinned to a specific commit
3636
```
3737

0 commit comments

Comments
 (0)