Project: etcd (Orchestration & Management / Coordination & Service Discovery)
File: release.md

The guide talks about how to release a new version of etcd. The procedure includes some manual steps for sanity checking, but it can probably be further scripted. Please keep this document up-to-date if making changes to the release process. The following pool of release candidates manages the release of each etcd major/minor version as well as manages patches to each stable release branch. They are responsible for communicating the timelines and status of each release and for ensuring the stability of the release branch. Benjamin Wang James Blair Marek Siarkowicz Sahdev Zala Wenjia Zhang All release version numbers follow the format of . Ensure the relevant milestone on GitHub is complete. All referenced issues should be closed or moved elsewhere. Ensure the latest upgrade documentation is available. Bump , if necessary. Add feature capability maps for the new version, if necessary. To request a backport, developers submit cherry-pick PRs targeting the release branch. The commits should not include merge commits. The commits should be restricted to bug fixes and security patches. The cherrypick PRs should target the appropriate release branch (`base:release-<major>-<minor>`). `hack/patch/cherrypick.sh` may be used to automatically generate cherrypick PRs. The release patch manager reviews the cherrypick PRs. Please discuss carefully what is backported to the patch release. Each patch release should be strictly better than its predecessor. The release patch manager will cherry-pick these commits starting from the oldest one into stable branch. Write an introduction for the new release. For example, what major bug we fix, what new features we introduce, or what performance improvement we make. Put `[GH XXXX]` at the head of the change line to reference the Pull Request that introduces the change. Moreover, add a link on it to jump to the Pull Request. Find PRs with the `release-note` label and explain them in the `NEWS` file, as a straightforward summary of changes for end-users. The etcd project aims to release a new patch version if any of the following conditions are met: Fixed one or more major CVEs (>=7.5). Fixed one or more critical bugs. Fixed three or more major bugs. Fixed five or more minor bugs. There are some prerequisites, which should be done before the release process. These are one-time operations, which don't need to be executed before releasing each version. Generate a GPG key and add it to your GitHub account. Refer to the links on . Ensure you have a Linux machine, on which the git, Golang, and docker have been

Ensure the Golang version matches the version defined in `.go-version` file. Ensure non-privileged users can run docker commands, refer to the . Ensure there is at least 500MB of free space on your Linux machine. Install gsutil, refer to . When asked about cloud project to use, pick `etcd-development`. Authenticate the image registry, refer to . `gcloud auth login` `gcloud auth configure-docker` Raise an issue to publish the release plan, e.g. . Verify you can pass the authentication to the image registries, `docker login gcr.io` `docker login quay.io` Clone the etcd repository and checkout the target branch, `git clone git@github.com:etcd-io/etcd.git` `git checkout release-3.X` Run the release script under the repository's root directory, replacing `${VERSION}` with a value without the `v` prefix, i.e. `3.5.13`. `DRY_RUN=false ./scripts/release.sh ${VERSION}` It generates all release binaries under the directory `./release` and images. Binaries are pushed to the Google Cloud bucket under project `etcd-development`, and images are pushed to `quay.io` and `gcr.io`. Publish the release page on GitHub Set the release title as the version name Follow the format of previous release pages Attach the generated binaries and signature file Select whether it's a pre-release Publish the release Announce to the etcd-dev googlegroup Follow the format of previous release emails sent to etcd-dev@googlegroups.com, see an example below, ``` Hello, etcd v3.4.30 is now public! https://github.com/etcd-io/etcd/releases/tag/v3.4.30 Thanks to everyone who contributed to the release! etcd team ``` Update the changelog to reflect the correct release date. Paste the release link to the issue raised in Step 1 and close the issue. Crease a new stable branch through `git push origin release-${VERSIONMAJOR}.${VERSIONMINOR}` if this is a new major or minor stable release. Timeouts pushing binaries - If binaries fail to fully upload to Google Cloud storage, the script must be re-run using the same command. Any artifacts that are already pushed will be overwritten to ensure they are correct. The storage bucket does not use object versioning so incorrect files cannot remain. Timeouts pushing images - It is rare, although possible for connection timeouts to occur when publishing etcd release images to `quay.io` or `gcr.io`. If this occurs, it is known to be safe to rerun the release script command appending the `--no-upload` flag, and image uploads will gracefully resume. GPG vs SSH signing - The release scripts assume that git tags will be signed with a GPG key. Since 2022 GitHub has supported . Until further release script updates are completed you will need to disable this feature in your `~/.gitconfig` and revert to signing via GPG to perform etcd releases.