Skip to content

Commit a41898e

Browse files
mrproliumrproliu
authored
Add changes and release guide documentations before release (#43)
1 parent 145620f commit a41898e

File tree

3 files changed

+195
-1
lines changed

3 files changed

+195
-1
lines changed

‎CHANGES.md‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
Changes by Version
2+
==================
3+
Release Notes.
4+
5+
1.0.0
6+
------------------
7+
#### Features
8+
* Support using `docker-compose` to setup the environment.
9+
* Support using the HTTP request as trigger.
10+
* Support verify test case by command-line or file with retry strategy.
11+
* Support GitHub Action.
12+
13+
#### Bug Fixes
14+
15+
#### Issues and PR
16+
- All issues are [here](https://github.com/apache/skywalking/milestone/98?closed=1)
17+
- All and pull requests are [here](https://github.com/apache/skywalking-infra-e2e/pulls?q=is%3Apr+is%3Aclosed+milestone%3A1.0.0)

‎docs/en/contribution/README.md‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,7 @@
22
If you want to debug or develop SkyWalking Infra E2E, The following documentations would guide you.
33

44
- Compiling
5-
- [Compiling Guidance](./Compiling-Guidance.md)
5+
- [Compiling Guidance](./Compiling-Guidance.md)
6+
7+
- Release
8+
- [Release Guidance](./Release-Guidance.md)

‎docs/en/contribution/Release-Guidance.md‎

Lines changed: 174 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,174 @@
1+
# Apache SkyWalking Infra E2E Release Guide
2+
3+
This documentation guides the release manager to release the SkyWalking Infra E2E in the Apache Way, and also helps people to check the release for voting.
4+
5+
## Prerequisites
6+
7+
1. Close (if finished, or move to next milestone otherwise) all issues in the current milestone from [skywalking-infra-e2e](https://github.com/apache/skywalking-infra-e2e/milestones) and [skywalking](https://github.com/apache/skywalking/milestones), create a new milestone if needed.
8+
1. Update [CHANGES.md](../../../CHANGES.md).
9+
10+
## Add your GPG public key to Apache svn
11+
12+
1. Upload your GPG public key to a public GPG site, such as [MIT's site](http://pgp.mit.edu:11371/).
13+
14+
1. Log in [id.apache.org](https://id.apache.org/) and submit your key fingerprint.
15+
16+
1. Add your GPG public key into [SkyWalking GPG KEYS](https://dist.apache.org/repos/dist/release/skywalking/KEYS) file, **you can do this only if you are a PMC member**. You can ask a PMC member for help. **DO NOT override the existed `KEYS` file content, only append your key at the end of the file.**
17+
18+
19+
## Build and sign the source code package
20+
21+
```shell
22+
export VERSION=<the version to release>
23+
24+
git clone --recurse-submodules git@github.com:apache/skywalking-infra-e2e.git && cd skywalking-infra-e2e
25+
git tag -a "v$VERSION" -m "Release Apache SkyWalking-Infra-E2E $VERSION"
26+
git push --tags
27+
28+
make clean
29+
30+
make test # this is optional, it runs sanity checks to verify the features
31+
32+
make release
33+
```
34+
35+
## Upload to Apache svn
36+
37+
```bash
38+
svn co https://dist.apache.org/repos/dist/dev/skywalking/infra-e2e release/skywalking/infra-e2e
39+
mkdir -p release/skywalking/infra-e2e/"$VERSION"
40+
cp skywalking-infra-e2e/skywalking*.tgz release/skywalking/infra-e2e/"$VERSION"
41+
cp skywalking-infra-e2e/skywalking*.tgz.asc release/skywalking/infra-e2e/"$VERSION"
42+
cp skywalking-infra-e2e/skywalking*.tgz.sha512 release/skywalking/infra-e2e/"$VERSION"
43+
44+
cd release/skywalking && svn add infra-e2e/$VERSION && svn commit infra-e2e -m "Draft Apache SkyWalking-Infra-E2E release $VERSION"
45+
```
46+
47+
## Call for vote in dev@ mailing list
48+
49+
Call for vote in `dev@skywalking.apache.org`.
50+
51+
```text
52+
Subject: [VOTE] Release Apache SkyWalking Infra E2E version $VERSION
53+
54+
Content:
55+
56+
Hi the SkyWalking Community:
57+
This is a call for vote to release Apache SkyWalking Infra E2E version $VERSION.
58+
59+
Release notes:
60+
61+
* https://github.com/apache/skywalking-infra-e2e/blob/v$VERSION/CHANGELOG.md
62+
63+
Release Candidate:
64+
65+
* https://dist.apache.org/repos/dist/dev/skywalking/infra-e2e/$VERSION
66+
* sha512 checksums
67+
- sha512xxxxyyyzzz skywalking-e2e-$VERSION-bin.tgz
68+
- sha512xxxxyyyzzz skywalking-e2e-$VERSION-src.tgz
69+
70+
Release Tag :
71+
72+
* (Git Tag) v$VERSION
73+
74+
Release Commit Hash :
75+
76+
* https://github.com/apache/skywalking-infra-e2e/tree/<Git Commit Hash>
77+
78+
Keys to verify the Release Candidate :
79+
80+
* https://dist.apache.org/repos/dist/release/skywalking/KEYS
81+
82+
Guide to build the release from source :
83+
84+
* https://github.com/apache/skywalking-infra-e2e/blob/main/docs/en/contribution/Compiling-Guidance.md
85+
86+
Voting will start now and will remain open for at least 72 hours, all PMC members are required to give their votes.
87+
88+
[ ] +1 Release this package.
89+
[ ] +0 No opinion.
90+
[ ] -1 Do not release this package because....
91+
92+
Thanks.
93+
94+
[1] https://github.com/apache/skywalking/blob/master/docs/en/guides/How-to-release.md#vote-check
95+
```
96+
97+
## Vote Check
98+
99+
All PMC members and committers should check these before voting +1:
100+
101+
1. Features test.
102+
1. All artifacts in staging repository are published with `.asc`, and `sha` files.
103+
1. Source codes and distribution packages (`skywalking-e2e-$VERSION-src.tgz`)
104+
are in `https://dist.apache.org/repos/dist/dev/skywalking/infra-e2e/$VERSION` with `.asc`, `.sha512`.
105+
1. `LICENSE` and `NOTICE` are in source codes and distribution package.
106+
1. Check `shasum -c skywalking-e2e-$VERSION-src.tgz.sha512`.
107+
1. Check `gpg --verify skywalking-e2e-$VERSION-src.tgz.asc skywalking-e2e-$VERSION-src.tgz`.
108+
1. Build distribution from source code package by following this [the build guide](#build-and-sign-the-source-code-package).
109+
110+
Vote result should follow these:
111+
112+
1. PMC vote is +1 binding, all others is +1 no binding.
113+
114+
1. Within 72 hours, you get at least 3 (+1 binding), and have more +1 than -1. Vote pass.
115+
116+
1. **Send the closing vote mail to announce the result**. When count the binding and no binding votes, please list the names of voters. An example like this:
117+
118+
```
119+
[RESULT][VOTE] Release Apache SkyWalking Infra E2E version $VERSION
120+
121+
72+ hours passed, we’ve got ($NUMBER) +1 bindings (and ... +1 non-bindings):
122+
123+
(list names)
124+
+1 bindings:
125+
xxx
126+
...
127+
128+
+1 non-bindings:
129+
xxx
130+
...
131+
132+
Thank you for voting, I’ll continue the release process.
133+
```
134+
135+
## Publish release
136+
137+
1. Move source codes tar balls and distributions to `https://dist.apache.org/repos/dist/release/skywalking/`, **you can do this only if you are a PMC member**.
138+
139+
```shell
140+
svn mv https://dist.apache.org/repos/dist/dev/skywalking/infra-e2e/"$VERSION" https://dist.apache.org/repos/dist/release/skywalking/infra-e2e/"$VERSION"
141+
```
142+
143+
1. Refer to the previous [PR](https://github.com/apache/skywalking-website/pull/132), update news and links on the website. There are several files need to modify.
144+
145+
1. Update [Github release page](https://github.com/apache/skywalking-infra-e2e/releases), follow the previous convention.
146+
147+
1. Send ANNOUNCE email to `dev@skywalking.apache.org` and `announce@apache.org`, the sender should use his/her Apache email account.
148+
149+
```
150+
Subject: [ANNOUNCEMENT] Apache SkyWalking Infra E2E $VERSION Released
151+
152+
Content:
153+
154+
Hi the SkyWalking Community
155+
156+
On behalf of the SkyWalking Team, I’m glad to announce that SkyWalking Infra E2E $VERSION is now released.
157+
158+
SkyWalking Infra E2E: An End-to-End Testing framework that aims to help developers to set up, debug, and verify E2E tests with ease.
159+
160+
SkyWalking: APM (application performance monitor) tool for distributed systems, especially designed for microservices, cloud native and container-based (Docker, Kubernetes, Mesos) architectures.
161+
162+
Download Links: http://skywalking.apache.org/downloads/
163+
164+
Release Notes : https://github.com/apache/skywalking-infra-e2e/blob/v$VERSION/CHANGELOG.md
165+
166+
Website: http://skywalking.apache.org/
167+
168+
SkyWalking Infra E2E Resources:
169+
- Issue: https://github.com/apache/skywalking/issues
170+
- Mailing list: dev@skywalking.apache.org
171+
- Documents: https://github.com/apache/skywalking-infra-e2e/blob/v$VERSION/README.md
172+
173+
The Apache SkyWalking Team
174+
```

0 commit comments

Comments
 (0)