Mirroristas/etcd
2
0
Fork 0
mirror of https://github.com/etcd-io/etcd.git synced 2024-09-27 06:25:44 +00:00
Code Issues Packages Projects Releases Wiki Activity

Improve release documentation

Browse Source 
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>
This commit is contained in:
ArkaSaha30 2024-09-11 00:37:41 +05:30
parent 4997a2bf93
commit 00f8a47d22
No known key found for this signature in database
GPG Key ID: C5FF37943E5BC363
1 changed files with 3 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
Documentation/contributor-guide/release.md
View File

@ -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
@ -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,