Skip to content

Commit c93e129

Browse files
committed
docs: update release docs (#1606)
- not every release is a prerelease, now, so update version guidance - add ethportal-api release instructions - don't rebase local master before tagging release If you have commits on your local master branch, rebasing would tag them into the release, bypassing the standard PR process.
1 parent d563617 commit c93e129

File tree

1 file changed

+21
-3
lines changed

1 file changed

+21
-3
lines changed

book/src/developers/contributing/releases/release_checklist.md

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,17 +15,35 @@ anything.
1515

1616
Make sure that version follows [semver](https://semver.org/) rules e.g (`0.2.0-alpha.3`).
1717

18-
**For the time being, ALWAYS specify the `-alpha` suffix.**
18+
Since trin is now stable, but v0, breaking changes are a minor version bump,
19+
and all other changes are a patch version bump. Updating to v1 would require a
20+
group discussion and decision.
1921

20-
## Release the version
22+
## Release dependencies
23+
24+
For now, that's just ethportal-api. Manually bump the version in the
25+
Cargo.toml, and run `cargo update` to update the workspace lockfile. Commit and
26+
merge these changes to trin. Then run:
27+
28+
```bash
29+
cd ethportal-api
30+
cargo publish --no-verify
31+
```
32+
33+
We would like to get rid of the no-verify ASAP, but for now Cargo.lock is
34+
causing issues that we have no other workaround for. `cargo publish` generates
35+
a new lock file, and then complains that the lockfile is new. See this
36+
[StackOverflow post](https://stackoverflow.com/questions/79276315/how-to-build-a-cargo-lock-file-for-a-package-within-a-workspace).
37+
38+
## Release Trin
2139

2240
We use automated github release workflow to create a new release.
2341
This will create a new release draft with the new tag and will build all the binaries and attach them to the release.
2442

2543
1. Checkout and rebase local master to upstream
2644
```bash
2745
git checkout master
28-
git pull --rebase upstream master
46+
git pull --ff-only upstream master
2947
```
3048
2. Create a new git tag with the chosen version, for example:
3149
```bash

0 commit comments

Comments
 (0)