Skip to content
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

docs: update release instructions #1146

Merged
merged 1 commit into from
Feb 8, 2024
Merged

docs: update release instructions #1146

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
42 changes: 20 additions & 22 deletions book/src/developers/contributing/releases/release_checklist.md
View file
Open in desktop
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
ogenev marked this conversation as resolved.
Show resolved Hide resolved
```

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
Loading