Skip to content

Commit

Permalink
Improve release documentation
Browse files Browse the repository at this point in the history
This commit will improve the release documentation guide by incorporating the following points:
1. Step 5 can be simplified to do a single-branch checkout
2. Step 6 should clarify that the release directory is in /tmp/etcd-release-${VERSION}/etcd/release/
3. Step 8 mention to add the "Release" label to the announcement message

Signed-off-by: ArkaSaha30 <arkasaha30@gmail.com>
  • Loading branch information
ArkaSaha30 committed Sep 10, 2024
1 parent 4997a2b commit 00f8a47
Showing 1 changed file with 3 additions and 4 deletions.
7 changes: 3 additions & 4 deletions Documentation/contributor-guide/release.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,12 +72,11 @@ which don't need to be executed before releasing each version.
- `docker login gcr.io`
- `docker login quay.io`
5. Clone the etcd repository and checkout the target branch,
- `git clone git@github.com:etcd-io/etcd.git`
- `git checkout release-3.X`
- `git clone --branch release-3.X git@github.com:etcd-io/etcd.git`
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}`

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`.
7. Publish the release page on GitHub
- Set the release title as the version name
Expand All @@ -88,7 +87,7 @@ which don't need to be executed before releasing each version.
- Publish the release
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
Hello,
Expand Down

0 comments on commit 00f8a47

Please sign in to comment.