You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
All releases version numbers follow the format of [semantic versioning 2.0.0](http://semver.org/).
19
+
All release version numbers follow the format of [semantic versioning 2.0.0](http://semver.org/).
20
20
21
21
### Major, minor version release, or its pre-release
22
22
23
-
- Ensure the relevant milestone on GitHub is complete. All referenced issues should be closed, or moved elsewhere.
23
+
- Ensure the relevant milestone on GitHub is complete. All referenced issues should be closed or moved elsewhere.
24
24
- Ensure the latest upgrade documentation is available.
25
25
- Bump [hardcoded MinClusterVerion in the repository](https://github.com/etcd-io/etcd/blob/v3.4.15/version/version.go#L29), if necessary.
26
26
- Add feature capability maps for the new version, if necessary.
27
27
28
28
### Patch version release
29
29
30
-
- To request a backport, developers submit cherrypick PRs targeting the release branch. The commits should not include merge commits. The commits should be restricted to bug fixes and security patches.
30
+
- 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.
31
31
- 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.
32
32
- 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.
33
33
- The release patch manager will cherry-pick these commits starting from the oldest one into stable branch.
34
34
35
-
## Write release note
35
+
## Write a release note
36
36
37
-
- Write introduction for the new release. For example, what major bug we fix, what new features we introduce or what performance improvement we make.
38
-
- Put `[GH XXXX]` at the head of change line to reference Pull Request that introduces the change. Moreover, add a link on it to jump to the Pull Request.
39
-
- Find PRs with `release-note` label and explain them in `NEWS` file, as a straightforward summary of changes for end-users.
37
+
- 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.
38
+
- 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.
39
+
- Find PRs with the `release-note` label and explain them in the`NEWS` file, as a straightforward summary of changes for end-users.
40
40
41
41
## Patch release criteria
42
42
@@ -51,21 +51,21 @@ The etcd project aims to release a new patch version if any of the following con
51
51
52
52
### Prerequisites
53
53
54
-
There are some prerequisites, which should be done before the release process. These are onetime operations,
54
+
There are some prerequisites, which should be done before the release process. These are one-time operations,
55
55
which don't need to be executed before releasing each version.
56
-
1. Generate a GPG key and add it to your github account. Refer to the links on [settings](https://github.com/settings/keys).
57
-
2. Ensure you have a Linux machine, on which the git, golang and docker have been installed.
58
-
- Ensure the golang version matches the version defined in `.go-version` file.
56
+
1. Generate a GPG key and add it to your GitHub account. Refer to the links on [settings](https://github.com/settings/keys).
57
+
2. Ensure you have a Linux machine, on which the git, Golang, and docker have been installed.
58
+
- Ensure the Golang version matches the version defined in `.go-version` file.
59
59
- Ensure non-privileged users can run docker commands, refer to the [Linux postinstall](https://docs.docker.com/engine/install/linux-postinstall/).
60
-
- Ensure there is at least 500MB free space on your Linux machine.
60
+
- Ensure there is at least 500MB of free space on your Linux machine.
61
61
3. Install gsutil, refer to [gsutil_install](https://cloud.google.com/storage/docs/gsutil_install).
62
62
4. Authenticate the image registry, refer to [Authentication methods](https://cloud.google.com/container-registry/docs/advanced-authentication).
63
63
-`gcloud auth login`
64
64
-`gcloud auth configure-docker`
65
65
66
66
### Release steps
67
67
68
-
1. Raise an issue to public the release plan, e.g. [issues/17350](https://github.com/etcd-io/etcd/issues/17350).
68
+
1. Raise an issue to publish the release plan, e.g. [issues/17350](https://github.com/etcd-io/etcd/issues/17350).
69
69
2. Verify you can pass the authentication to the image registries,
70
70
-`docker login gcr.io`
71
71
-`docker login quay.io`
@@ -75,10 +75,10 @@ which don't need to be executed before releasing each version.
75
75
4. Run the release script under the repository's root directory, replacing `${VERSION}` with a value without the `v` prefix, i.e. `3.5.13`.
76
76
-`DRY_RUN=false ./scripts/release.sh ${VERSION}`
77
77
78
-
It generates all release binaries under directory `./release` and images. Binaries are pushed to the google cloud bucket
78
+
It generates all release binaries under the directory `./release` and images. Binaries are pushed to the Google Cloud bucket
79
79
under project `etcd-development`, and images are pushed to `quay.io` and `gcr.io`.
80
-
5. Publish release page in Github
81
-
- Set release title as the version name
80
+
5. Publish the release page on GitHub
81
+
- Set the release title as the version name
82
82
- Follow the format of previous release pages
83
83
- Attach the generated binaries and signature file
84
84
- Select whether it's a pre-release
@@ -98,13 +98,13 @@ Thanks to everyone who contributed to the release!
98
98
etcd team
99
99
```
100
100
7. Update the changelog to reflect the correct release date.
101
-
8. Paste the release link to the issue raised at step 1 and close the issue.
101
+
8. Paste the release link to the issue raised in Step 1 and close the issue.
102
102
9. Crease a new stable branch through `git push origin release-${VERSION_MAJOR}.${VERSION_MINOR}` if this is a new major or minor stable release.
103
103
104
104
#### Release known issues
105
105
106
-
1. 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 already pushed will be overwritten to ensure they are correct. The storage bucket does not use object versioning so there no possibility for incorrect files to remain.
106
+
1. 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.
107
107
108
-
2. 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.
108
+
2. 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.
109
109
110
110
3. GPG vs SSH signing - The release scripts assume that git tags will be signed with a GPG key. Since 2022 GitHub has supported [signing commits and tags using ssh](https://github.blog/changelog/2022-08-23-ssh-commit-verification-now-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.
0 commit comments