Skip to content

Commit 7c63af2

Browse files
authored
Update release doc to reflect new steps (#306)
1 parent 7a1c711 commit 7c63af2

4 files changed

Lines changed: 42 additions & 15 deletions

File tree

.dlc.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
"ignorePatterns": [
33
{
44
"pattern": "^http://localhost"
5+
},
6+
{
7+
"pattern": "https://twitter.com*"
58
}
69
],
710
"timeout": "10s",

docs/en/contribution/How-to-release-docker.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,19 @@
11
# Apache SkyWalking Python Image Release Guide
22

3-
This documentation shows the way to build and push the SkyWalking Python images to DockerHub.
3+
The official process generating a list of images covering most used Python versions and variations(grpc/http/kafka) of the Python agent is deployed to our GitHub actions and therefore do not rely on this documentation.
44

5-
## Prerequisites
5+
This documentation shows the way to build and push the SkyWalking Python images manually.
6+
7+
## How to build manually
68

79
Before building the latest release of images, make sure an official release is pushed to PyPI where the dockerfile will depend on.
810

911
## Images
1012

11-
This process wil generate a list of images covering most used Python versions and variations(grpc/http/kafka) of the Python agent.
13+
The process generating a list of images covering most used Python versions and variations(grpc/http/kafka) of the Python agent is deployed to
14+
our GitHub actions.
1215

13-
The convenience images are published to Docker Hub and available from the `skywalking.docker.scarf.sh` endpoint.
14-
- `skywalking.docker.scarf.sh/apache/skywalking-python` ([Docker Hub](https://hub.docker.com/r/apache/skywalking-python))
16+
The convenience images are published to [DockerHub](https://hub.docker.com/r/apache/skywalking-python)
1517

1618
## How to build
1719

docs/en/contribution/How-to-release.md

Lines changed: 29 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -31,16 +31,22 @@ make clean && make release
3131
```bash
3232
svn co https://dist.apache.org/repos/dist/dev/skywalking/python release/skywalking/python
3333
mkdir -p release/skywalking/python/"$VERSION"
34-
cp skywalking-python/skywalking*.tgz release/skywalking/python/"$VERSION"
35-
cp skywalking-python/skywalking*.tgz.asc release/skywalking/python/"$VERSION"
36-
cp skywalking-python/skywalking-python*.tgz.sha512 release/skywalking/python/"$VERSION"
34+
cp skywalking*.tgz release/skywalking/python/"$VERSION"
35+
cp skywalking*.tgz.asc release/skywalking/python/"$VERSION"
36+
cp skywalking-python*.tgz.sha512 release/skywalking/python/"$VERSION"
3737

3838
cd release/skywalking && svn add python/$VERSION && svn commit python -m "Draft Apache SkyWalking-Python release $VERSION"
3939
```
4040

4141
## Make the internal announcement
4242

43-
Send an announcement email to dev@ mailing list, **please check all links before sending the email**, the same below.
43+
First, generate a sha512sum for the source code package generated in last step:
44+
45+
```bash
46+
sha512sum release/skywalking/python/"$VERSION"/skywalking-python-src-"$VERSION".tgz
47+
```
48+
49+
Send an announcement email to dev@ mailing list, **please check all links before sending the email**, the same as below.
4450

4551
```text
4652
Subject: [ANNOUNCEMENT] Apache SkyWalking Python $VERSION test build available
@@ -183,11 +189,27 @@ Vote result should follow these:
183189
svn mv https://dist.apache.org/repos/dist/dev/skywalking/python/"$VERSION" https://dist.apache.org/repos/dist/release/skywalking/python/"$VERSION"
184190
```
185191

186-
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.
192+
2. Refer to the previous [PR](https://github.com/apache/skywalking-website/pull/571), update news and links on the website. There are several files need to modify.
193+
194+
195+
### Publish PyPI package
196+
197+
After the official ASF release, we publish the packaged wheel to the PyPI index.
198+
199+
1. Make sure the final upload is correct by using the test PyPI index `make upload-test`.
200+
2. Upload the final artifacts by running `make upload`.
201+
202+
### Publish Docker images
203+
204+
After the release on GitHub, a GitHub Action will be triggered to build Docker images based on the latest code.
205+
206+
**Important** We announce the new release by drafting one on [Github release page](https://github.com/apache/skywalking-python/releases), following the previous convention.
207+
208+
An automation via GitHub Actions will automatically trigger upon the mentioned release event to build and upload Docker images to DockerHub.
187209

188-
1. Update [Github release page](https://github.com/apache/skywalking-python/releases), follow the previous convention.
210+
See [How-to-release-docker](./How-to-release-docker.md) for a detailed description of manual release.
189211

190-
1. Send ANNOUNCE email to `dev@skywalking.apache.org` and `announce@apache.org`, the sender should use his/her Apache email account.
212+
4. Send ANNOUNCEMENT email to `dev@skywalking.apache.org` and `announce@apache.org`, the sender should use his/her Apache email account.
191213

192214
```
193215
Subject: [ANNOUNCEMENT] Apache SkyWalking Python $VERSION Released

docs/en/setup/Container.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,17 +8,17 @@ Python 3.7 - 3.11.
88

99
## How to use this image
1010

11-
The images are hosted at [Docker Hub](https://hub.docker.com/r/apache/skywalking-python) and available from the `skywalking.docker.scarf.sh` endpoint.
11+
The images are hosted at [Docker Hub](https://hub.docker.com/r/apache/skywalking-python).
1212

13-
`skywalking.docker.scarf.sh/apache/skywalking-python`
13+
The images come with protocol variants(gRPC, Kafka, HTTP) and base Python variants(Full, Slim).
1414

1515
### Build your Python application image on top of this image
1616

1717
Start by pulling the `skywalking-python` image as the base of your application image.
1818
Refer to [Docker Hub](https://hub.docker.com/r/apache/skywalking-python) for the list of tags available.
1919

2020
```dockerfile
21-
FROM apache/skywalking-python:0.7.0-grpc-py3.9
21+
FROM apache/skywalking-python:1.1.0-grpc-py3.10
2222

2323
# ... build your Python application
2424
```

0 commit comments

Comments
 (0)