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.

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

Creates a new issue template for releases #6972

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
38 changes: 38 additions & 0 deletions .github/ISSUE_TEMPLATE/release-checklist.md
@@ -0,0 +1,38 @@
---
name: Release Checklist
about: items to be completed for each release
title: ''
labels: ''
assignees: ''

---

- [ ] Confirm anything outstanding for release with other maintainers on #besu-release
- [ ] Update changelog if necessary
- [ ] Notify maintainers about updating changelog for in-flight PRs
- [ ] Optional: for hotfixes, create a release branch and cherry-pick, e.g. `release-<version>-hotfix`
- [ ] Optional: create a PR against the hotfix branch to see the CI checks pass
- [ ] On the appropriate branch/commit, create a calver tag for the release candidate, format example: 24.4.0-RC2
- [ ] Create a DRAFT release using the new tag (careful not to publish!)
- [ ] Draft homebrew PR
- [ ] Draft documentation release
- [ ] Sign-off with team
- [ ] Start burn-in using the new <version-RCX> tag
- [ ] Sign off burn-in
- [ ] Convert the DRAFT into a PRE-RELEASE
- this is now public and notifies subscribed users
- publishes artefacts and version-specific docker tags
Comment on lines +22 to +24
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have removed this step from the WIP checklist as it would result in creating redundant 24.5.0-RC1 artefacts.

See #6963 (comment) for context.

Most of the time we will want to go straight from draft/burn-in -> full release, with pre-release being a necessary in-between step for now. That pre-release needs to use the full release tag e.g. 24.5.0 instead of 24.5.0-RC1.

- [ ] Using the same git sha, create a new tag for the FULL RELEASE, example format 24.4.0
- [ ] Using the FULL RELEASE tag, create a PRE-RELEASE in github to trigger the workflows
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

does this mean we get 2 pre-releases? one for the RC and one for the full release tag?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is copypasta from @siladu but i interpreted it as using pre-release is optional for RCs

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok fair enough. DCO is broken tho

Copy link
Contributor

@siladu siladu Apr 24, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is the part I asked for feedback on.

This is also in flux due to #6963
Am currently testing out scenarios with this PR.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- [ ] Using the FULL RELEASE tag, create a PRE-RELEASE in github to trigger the workflows
- [ ] Using the FULL RELEASE tag, create a PRE-RELEASE in github to trigger the workflows
- this is now public and notifies subscribed users
- publishes artefacts and version-specific docker tags

Moving extra comments from the removed step above

- [ ] Convert this to a FULL RELEASE
- makes the release LATEST in github
- publishes the docker `latest` tag variants
- [ ] Ensure binary SHAs are correct on the release page
- [ ] Docker release startup test:
- `docker run hyperledger/besu:<version>`
- `docker run hyperledger/besu:<version>-arm64`
- `docker run --platform linux/amd64 hyperledger/besu:<version>-amd64`
- `docker run --pull=always hyperledger/besu:latest` (check version is <version>)
- [ ] Merge homebrew PR
- [ ] Publish Docs Release
- [ ] Social announcements