Merge pull request #18572 from ArkaSaha30/release-doc-update

Improve release documentation
This commit is contained in:
Benjamin Wang 2024-09-11 09:40:45 +01:00 committed by GitHub
commit 5088131f51
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -72,12 +72,11 @@ which don't need to be executed before releasing each version.
- `docker login gcr.io` - `docker login gcr.io`
- `docker login quay.io` - `docker login quay.io`
5. Clone the etcd repository and checkout the target branch, 5. Clone the etcd repository and checkout the target branch,
- `git clone git@github.com:etcd-io/etcd.git` - `git clone --branch release-3.X git@github.com:etcd-io/etcd.git`
- `git checkout release-3.X`
6. Run the release script under the repository's root directory, replacing `${VERSION}` with a value without the `v` prefix, i.e. `3.5.13`. 6. 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}` - `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 It generates all release binaries under the directory `/tmp/etcd-release-${VERSION}/etcd/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`. under project `etcd-development`, and images are pushed to `quay.io` and `gcr.io`.
7. Publish the release page on GitHub 7. Publish the release page on GitHub
- Set the release title as the version name - Set the release title as the version name
@ -88,7 +87,7 @@ which don't need to be executed before releasing each version.
- Publish the release - Publish the release
8. Announce to the etcd-dev googlegroup 8. Announce to the etcd-dev googlegroup
Follow the format of previous release emails sent to etcd-dev@googlegroups.com, see an example below. After sending out the email, ask one of the mailing list maintainers to approve the email from the pending list. Follow the format of previous release emails sent to etcd-dev@googlegroups.com, see an example below. After sending out the email, ask one of the mailing list maintainers to approve the email from the pending list. Additionally, label the release email as `Release`.
```text ```text
Hello, Hello,