Skip to content

Commit 8bd6b77

Browse files
committed
docs(releases): document fixture release process and tracks
1 parent c43a97b commit 8bd6b77

1 file changed

Lines changed: 14 additions & 0 deletions

File tree

docs/running_tests/releases.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,20 @@ On success the workflow:
9797

9898
The release is created as a draft; review and publish it from the GitHub releases page.
9999

100+
### Tagging A Release
101+
102+
To cut a new release:
103+
104+
1. **Pick the next version** per the [Versioning Scheme](#versioning-scheme) for the track you're releasing on (e.g. the next consensus release after `consensus@v20.3.0` is `consensus@v20.3.1` for a tests-only bump, or `consensus@v20.4.0` for a behaviour change).
105+
2. **Dispatch the workflow** from the [Actions tab](https://github.com/ethereum/execution-specs/actions/workflows/release_fixtures.yaml) or via the CLI:
106+
```bash
107+
gh workflow run release_fixtures.yaml -f feature=consensus@v20.3.1
108+
# devnet releases additionally require the branch to release from:
109+
gh workflow run release_fixtures.yaml -f feature=bal-devnet@v1.0.0 -f branch=bal-devnet-7
110+
```
111+
3. **Wait for the build to succeed.** On success the workflow creates the `tests-<feature>@vX.Y.Z` tag on the target commit and drafts the GitHub release with the fixture tarball attached. If any job fails, no tag or release is created — fix the cause and re-dispatch.
112+
4. **Review and publish the draft.** Open the draft on the [releases page](https://github.com/ethereum/execution-specs/releases), check the auto-generated notes (anchored at the prior release on the same track via `--notes-start-tag`), and click *Publish release* when ready.
113+
100114
!!! tip "Release features opt into all fixture formats via `feature.yaml`"
101115
Tarball output (`.tar.gz`) does not by itself include the pre-allocation group formats (`BlockchainEngineXFixture`, `BlockchainEngineStatefulFixture`). A release feature requests them by adding `--generate-all-formats` to its `fill-params` in `.github/configs/feature.yaml`:
102116
```console

0 commit comments

Comments
 (0)