You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@skywalking.apache.org by ke...@apache.org on 2023/05/14 10:36:57 UTC

[skywalking-python] branch master updated: Update release doc to reflect new steps (#306)

This is an automated email from the ASF dual-hosted git repository.

kezhenxu94 pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/skywalking-python.git


The following commit(s) were added to refs/heads/master by this push:
     new 7c63af2  Update release doc to reflect new steps (#306)
7c63af2 is described below

commit 7c63af268a4c10806c67761cbf07c91bedb76f1f
Author: Superskyyy <Su...@outlook.com>
AuthorDate: Sun May 14 06:36:52 2023 -0400

    Update release doc to reflect new steps (#306)
---
 .dlc.json                                     |  3 +++
 docs/en/contribution/How-to-release-docker.md | 12 +++++----
 docs/en/contribution/How-to-release.md        | 36 +++++++++++++++++++++------
 docs/en/setup/Container.md                    |  6 ++---
 4 files changed, 42 insertions(+), 15 deletions(-)

diff --git a/.dlc.json b/.dlc.json
index d666fce..c065983 100644
--- a/.dlc.json
+++ b/.dlc.json
@@ -2,6 +2,9 @@
   "ignorePatterns": [
     {
       "pattern": "^http://localhost"
+    },
+    {
+      "pattern": "https://twitter.com*"
     }
   ],
   "timeout": "10s",
diff --git a/docs/en/contribution/How-to-release-docker.md b/docs/en/contribution/How-to-release-docker.md
index e8902d6..6621e6d 100644
--- a/docs/en/contribution/How-to-release-docker.md
+++ b/docs/en/contribution/How-to-release-docker.md
@@ -1,17 +1,19 @@
 # Apache SkyWalking Python Image Release Guide
 
-This documentation shows the way to build and push the SkyWalking Python images to DockerHub.
+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.
 
-## Prerequisites
+This documentation shows the way to build and push the SkyWalking Python images manually. 
+
+## How to build manually
 
 Before building the latest release of images, make sure an official release is pushed to PyPI where the dockerfile will depend on.
 
 ## Images
 
-This process wil generate a list of images covering most used Python versions and variations(grpc/http/kafka) of the Python agent.
+The 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.
 
-The convenience images are published to Docker Hub and available from the `skywalking.docker.scarf.sh` endpoint.
-- `skywalking.docker.scarf.sh/apache/skywalking-python` ([Docker Hub](https://hub.docker.com/r/apache/skywalking-python))
+The convenience images are published to [DockerHub](https://hub.docker.com/r/apache/skywalking-python)
 
 ## How to build
 
diff --git a/docs/en/contribution/How-to-release.md b/docs/en/contribution/How-to-release.md
index d91b167..2ba70d4 100644
--- a/docs/en/contribution/How-to-release.md
+++ b/docs/en/contribution/How-to-release.md
@@ -31,16 +31,22 @@ make clean && make release
 ```bash
 svn co https://dist.apache.org/repos/dist/dev/skywalking/python release/skywalking/python
 mkdir -p release/skywalking/python/"$VERSION"
-cp skywalking-python/skywalking*.tgz release/skywalking/python/"$VERSION"
-cp skywalking-python/skywalking*.tgz.asc release/skywalking/python/"$VERSION"
-cp skywalking-python/skywalking-python*.tgz.sha512 release/skywalking/python/"$VERSION"
+cp skywalking*.tgz release/skywalking/python/"$VERSION"
+cp skywalking*.tgz.asc release/skywalking/python/"$VERSION"
+cp skywalking-python*.tgz.sha512 release/skywalking/python/"$VERSION"
 
 cd release/skywalking && svn add python/$VERSION && svn commit python -m "Draft Apache SkyWalking-Python release $VERSION"
 ```
 
 ## Make the internal announcement
 
-Send an announcement email to dev@ mailing list, **please check all links before sending the email**, the same below.
+First, generate a sha512sum for the source code package generated in last step:
+
+```bash
+sha512sum release/skywalking/python/"$VERSION"/skywalking-python-src-"$VERSION".tgz
+``` 
+
+Send an announcement email to dev@ mailing list, **please check all links before sending the email**, the same as below.
 
 ```text
 Subject: [ANNOUNCEMENT] Apache SkyWalking Python $VERSION test build available
@@ -183,11 +189,27 @@ Vote result should follow these:
     svn mv https://dist.apache.org/repos/dist/dev/skywalking/python/"$VERSION" https://dist.apache.org/repos/dist/release/skywalking/python/"$VERSION"
     ```
     
-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.
+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.
+
+
+### Publish PyPI package
+
+After the official ASF release, we publish the packaged wheel to the PyPI index.
+
+1. Make sure the final upload is correct by using the test PyPI index `make upload-test`.
+2. Upload the final artifacts by running `make upload`.
+
+### Publish Docker images
+
+After the release on GitHub, a GitHub Action will be triggered to build Docker images based on the latest code.
+
+**Important** We announce the new release by drafting one on [Github release page](https://github.com/apache/skywalking-python/releases), following the previous convention.
+
+An automation via GitHub Actions will automatically trigger upon the mentioned release event to build and upload Docker images to DockerHub.
 
-1. Update [Github release page](https://github.com/apache/skywalking-python/releases), follow the previous convention.
+See [How-to-release-docker](./How-to-release-docker.md) for a detailed description of manual release.
 
-1. Send ANNOUNCE email to `dev@skywalking.apache.org` and `announce@apache.org`, the sender should use his/her Apache email account. 
+4. Send ANNOUNCEMENT email to `dev@skywalking.apache.org` and `announce@apache.org`, the sender should use his/her Apache email account. 
 
     ```
     Subject: [ANNOUNCEMENT] Apache SkyWalking Python $VERSION Released
diff --git a/docs/en/setup/Container.md b/docs/en/setup/Container.md
index ef443c2..2f7f251 100644
--- a/docs/en/setup/Container.md
+++ b/docs/en/setup/Container.md
@@ -8,9 +8,9 @@ Python 3.7 - 3.11.
 
 ## How to use this image
 
-The images are hosted at [Docker Hub](https://hub.docker.com/r/apache/skywalking-python) and available from the `skywalking.docker.scarf.sh` endpoint.
+The images are hosted at [Docker Hub](https://hub.docker.com/r/apache/skywalking-python).
 
-`skywalking.docker.scarf.sh/apache/skywalking-python`
+The images come with protocol variants(gRPC, Kafka, HTTP) and base Python variants(Full, Slim).
 
 ### Build your Python application image on top of this image
 
@@ -18,7 +18,7 @@ Start by pulling the `skywalking-python` image as the base of your application i
 Refer to [Docker Hub](https://hub.docker.com/r/apache/skywalking-python) for the list of tags available.
 
 ```dockerfile
-FROM apache/skywalking-python:0.7.0-grpc-py3.9
+FROM apache/skywalking-python:1.1.0-grpc-py3.10
 
 # ... build your Python application
 ```