Skip to content

Commit ec4db3a

Browse files
authored
Polish the release doc and fix some typos (#75)
1 parent 814817c commit ec4db3a

File tree

1 file changed

+28
-28
lines changed

1 file changed

+28
-28
lines changed

docs/How-to-release.md

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Apache SkyWalking CLI release guide
1+
# Apache SkyWalking CLI Release Guide
22

33
This documentation guides the release manager to release the SkyWalking CLI in the Apache Way, and also helps people to check the release for vote.
44

@@ -27,7 +27,7 @@ git push --tags
2727
make clean && make release
2828
```
2929

30-
The `skywalking-cli-${VERSION}-bin.tgz`, `skywalking-cli-${VERSION}-src.tgz`, and their corresponding `asc`, `sha512`. **In total, six files should be automatically generated in the directory.**
30+
**In total, six files should be automatically generated in the directory**: `skywalking-cli-${VERSION}-bin.tgz`, `skywalking-cli-${VERSION}-src.tgz`, and their corresponding `asc`, `sha512` files.
3131

3232
## Upload to Apache svn
3333

@@ -43,7 +43,7 @@ cd skywalking/cli && svn add "$VERSION" && svn commit -m "Draft Apache SkyWalkin
4343

4444
## Make the internal announcement
4545

46-
Send an announcement email to dev@ mailing list.
46+
Send an announcement email to dev@ mailing list, **please check all links before sending the email**.
4747

4848
```text
4949
Subject: [ANNOUNCEMENT] SkyWalking CLi $VERSION test build available
@@ -57,7 +57,7 @@ account if a quality vote is called for this build.
5757
5858
Release notes:
5959
60-
* https://github.com/apache/skywalking-cli/blob/v$VERSION/CHANGES.md
60+
* https://github.com/apache/skywalking-cli/blob/$VERSION/CHANGES.md
6161
6262
Release Candidate:
6363
@@ -80,7 +80,7 @@ Keys to verify the Release Candidate :
8080
8181
Guide to build the release from source :
8282
83-
* https://github.com/apache/skywalking-cli/blob/v$VERSION/docs/How-to-release.md
83+
* https://github.com/apache/skywalking-cli/blob/$VERSION/docs/How-to-release.md
8484
8585
A vote regarding the quality of this test build will be initiated
8686
within the next couple of days.
@@ -93,7 +93,7 @@ Based on that, PMC will decide whether to start a vote or not.
9393

9494
## Call for vote in dev@ mailing list
9595

96-
Call for vote in `dev@skywalking.apache.org`
96+
Call for vote in `dev@skywalking.apache.org`, **please check all links before sending the email**.
9797

9898
```text
9999
Subject: [VOTE] Release Apache SkyWalking CLI version $VERSION
@@ -105,14 +105,14 @@ This is a call for vote to release Apache SkyWalking CLI version $VERSION.
105105
106106
Release notes:
107107
108-
* https://github.com/apache/skywalking-cli/blob/v$VERSION/CHANGES.md
108+
* https://github.com/apache/skywalking-cli/blob/$VERSION/CHANGES.md
109109
110110
Release Candidate:
111111
112112
* https://dist.apache.org/repos/dist/dev/skywalking/cli/$VERSION
113113
* sha512 checksums
114-
- sha512xxxxyyyzzz apache-skywalking-cli-src-x.x.x.tgz
115-
- sha512xxxxyyyzzz apache-skywalking-cli-bin-x.x.x.tgz
114+
- sha512xxxxyyyzzz skywalking-cli-x.x.x-src.tgz
115+
- sha512xxxxyyyzzz skywalking-cli-x.x.x-bin.tgz
116116
117117
Release Tag :
118118
@@ -128,7 +128,7 @@ Keys to verify the Release Candidate :
128128
129129
Guide to build the release from source :
130130
131-
* https://github.com/apache/skywalking-cli/blob/v$VERSION/docs/How-to-release.md
131+
* https://github.com/apache/skywalking-cli/blob/$VERSION/docs/How-to-release.md
132132
133133
Voting will start now and will remain open for at least 72 hours, all PMC members are required to give their votes.
134134
@@ -147,12 +147,13 @@ All PMC members and committers should check these before voting +1:
147147

148148
1. Features test.
149149
1. All artifacts in staging repository are published with `.asc`, `.md5`, and `sha` files.
150-
1. Source codes and distribution packages (`apache-skywalking-cli-{src,bin}-$VERSION.tgz`)
150+
1. Source codes and distribution packages (`skywalking-cli-$VERSION-{src,bin}.tgz`)
151151
are in `https://dist.apache.org/repos/dist/dev/skywalking/cli/$VERSION` with `.asc`, `.sha512`.
152152
1. `LICENSE` and `NOTICE` are in source codes and distribution package.
153-
1. Check `shasum -c apache-skywalking-cli-{src,bin}-$VERSION.tgz.sha512`.
153+
1. Check `shasum -c skywalking-cli-$VERSION-{src,bin}.tgz.sha512`.
154+
1. Check `gpg --verify skywalking-cli-$VERSION-{src,bin}.tgz.asc skywalking-cli-$VERSION-{src,bin}.tgz`.
154155
1. Build distribution from source code package by following this [the build guide](#build-and-sign-the-source-code-package).
155-
1. Licenses check, `make license.`
156+
1. Licenses check, `make license`.
156157

157158
Vote result should follow these:
158159

@@ -165,14 +166,18 @@ Vote result should follow these:
165166
```
166167
[RESULT][VOTE] Release Apache SkyWalking CLI version $VERSION
167168
168-
3 days passed, we’ve got ($NUMBER) +1 bindings:
169-
xxx
169+
3 days passed, we’ve got ($NUMBER) +1 bindings (and ... +1 non-bindings):
170+
171+
(list names)
172+
+1 bindings:
170173
xxx
174+
...
175+
176+
+1 non-bindings:
171177
xxx
172178
...
173-
(list names)
174179
175-
I’ll continue the release process.
180+
Thank you for voting, I’ll continue the release process.
176181
```
177182

178183
## Publish release
@@ -182,16 +187,13 @@ Vote result should follow these:
182187
```shell
183188
export SVN_EDITOR=vim
184189
svn mv https://dist.apache.org/repos/dist/dev/skywalking/cli/$VERSION https://dist.apache.org/repos/dist/release/skywalking/cli
185-
# ....
186-
# enter your apache password
187-
# ....
188190
```
189-
191+
190192
1. Refer to the previous [PR](https://github.com/apache/skywalking-website/pull/118), update news and links on the website. There are seven files need to modify.
191193

192194
1. Update [Github release page](https://github.com/apache/skywalking-cli/releases), follow the previous convention.
193195

194-
1. Send ANNOUNCE email to `dev@skywalking.apache.org` and `announce@apache.org`, the sender should use his/her Apache email account. You can get the permlink of vote thread at [here](https://lists.apache.org/list.html?dev@skywalking.apache.org).
196+
1. Send ANNOUNCE email to `dev@skywalking.apache.org` and `announce@apache.org`, the sender should use his/her Apache email account, **please check all links before sending the email**.
195197

196198
```
197199
Subject: [ANNOUNCEMENT] Apache SkyWalking CLI $VERSION Released
@@ -206,20 +208,18 @@ Vote result should follow these:
206208

207209
SkyWalking: APM (application performance monitor) tool for distributed systems, especially designed for microservices, cloud native and container-based (Docker, Kubernetes, Mesos) architectures.
208210

209-
Vote Thread: $VOTE_THREAD_PERMALINK
210-
211211
Download Links: http://skywalking.apache.org/downloads/
212212

213213
Release Notes : https://github.com/apache/skywalking-cli/blob/$VERSION/CHANGES.md
214214

215215
Website: http://skywalking.apache.org/
216216

217217
SkyWalking CLI Resources:
218-
- Issue: https://github.com/apache/skywalking/issues
219-
- Mailing list: dev@skywalkiing.apache.org
218+
- Issue: https://github.com/apache/skywalking/issues
219+
- Mailing list: dev@skywalking.apache.org
220220
- Documents: https://github.com/apache/skywalking-cli/blob/$VERSION/README.md
221-
221+
222222
The Apache SkyWalking Team
223-
```
223+
```
224224

225225

0 commit comments

Comments
 (0)