Skip to content

Commit

Permalink
docs(book): update release instructions (ethereum#1146)
Browse files Browse the repository at this point in the history
  • Loading branch information
ogenev authored Feb 8, 2024
1 parent 0c7e22b commit 029eb51
Showing 1 changed file with 20 additions and 22 deletions.
42 changes: 20 additions & 22 deletions book/src/developers/contributing/releases/release_checklist.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,31 +17,29 @@ Make sure that version follows [semver](https://semver.org/) rules e.g (`0.2.0-a

**For the time being, ALWAYS specify the `-alpha` suffix.**

## Bump the version
## Release the version

- In github, open the page to [create the new release](https://github.com/ethereum/trin/releases/new).
- In the tag, type out the version number that the new release bumps to and select "Create new tag".
- Github should say "Excellent! This tag will be created from the target when you publish this release."
- Click "Generate release notes"
- Select "Set as a pre-release"
- Add "Trin " to the beginning of the release title
- Add any clarifying information that's helpful about the release
We use automated github release workflow to create a new release.
This will create a new release draft with the new tag and will build all the binaries and attach them to the release.

## Build the binary for release

> ⚠️ **Under development**: This is an untested rough draft. Pair up when
> releasing, to verify.
Build the binary with:

```sh
cargo build --release
1. Checkout and rebase local master to upstream
```bash
git checkout master
git pull --rebase upstream master
```

We no longer use `make release` because it's not worth the effort to release all the dependencies.

> ⚠️ **TODO**: How do we generate binaries for all target systems, for this
> release page? Linux, Mac, Windows, ARM, etc
2. Create a new git tag with the chosen version, for example:
```bash
git tag v0.1.0-alpha.15
```
3. Push the tag to the upstream repository:
```bash
git push upstream v0.1.0-alpha.15
```
4. Wait for the github actions release job to finish. It will create automatically a draft release with all precompiled binaries included.
This should take 15-20 min to complete.
5. Find the draft release generated by the github bot in releases and edit the template by completing and deleting all checklists.
Write a short summary if available. Add any clarifying information that's helpful about the release.
6. Scroll to the bottom, check the `Set as a pre-release` box and click `Publish release`.

### Build Instructions
* [Linux](../build_instructions/linux.md)
Expand Down

0 comments on commit 029eb51

Please sign in to comment.