Apache SkyWalking Python Release Guide
This documentation guides the release manager to release the SkyWalking Python in the Apache Way, and also helps people to check the release for vote.
Prerequisites
- Close (if finished, or move to next milestone otherwise) all issues in the current milestone from skywalking-python and skywalking, create a new milestone if needed.
- Update CHANGELOG.md and
version
inpyproject.toml
.
Add your GPG public key to Apache SVN
-
Log in id.apache.org and submit your key fingerprint.
-
Add your GPG public key into SkyWalking GPG 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.
Build and sign the source code package
export VERSION=<the version to release>
git clone --recurse-submodules git@github.com:apache/skywalking-python && cd skywalking-python
git tag -a "v$VERSION" -m "Release Apache SkyWalking-Python $VERSION"
git push --tags
make clean && make release
Upload to Apache SVN
svn co https://dist.apache.org/repos/dist/dev/skywalking/python release/skywalking/python
mkdir -p 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
First, generate a sha512sum for the source code package generated in last step:
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.
Subject: [ANNOUNCEMENT] Apache SkyWalking Python $VERSION test build available
Content:
The test build of Apache SkyWalking Python $VERSION is now available.
We welcome any comments you may have, and will take all feedback into
account if a quality vote is called for this build.
Release notes:
* https://github.com/apache/skywalking-python/blob/v$VERSION/CHANGELOG.md
Release Candidate:
* https://dist.apache.org/repos/dist/dev/skywalking/python/$VERSION
* sha512 checksums
- sha512xxxxyyyzzz skywalking-python-src-x.x.x.tgz
Release Tag :
* (Git Tag) v$VERSION
Release Commit Hash :
* https://github.com/apache/skywalking-python/tree/<Git Commit Hash>
Keys to verify the Release Candidate :
* http://pgp.mit.edu:11371/pks/lookup?op=get&search=0x8BD99F552D9F33D7 corresponding to kezhenxu94@apache.org
Guide to build the release from source :
* https://github.com/apache/skywalking-python/blob/master/CONTRIBUTING.md#compiling-and-building
A vote regarding the quality of this test build will be initiated
within the next couple of days.
Wait at least 48 hours for test responses
Any PMC, committer or contributor can test features for releasing, and feedback. Based on that, PMC will decide whether to start a vote or not.
Call for vote in dev@ mailing list
Call for vote in dev@skywalking.apache.org
.
Subject: [VOTE] Release Apache SkyWalking Python version $VERSION
Content:
Hi the SkyWalking Community:
This is a call for vote to release Apache SkyWalking Python version $VERSION.
Release notes:
* https://github.com/apache/skywalking-python/blob/v$VERSION/CHANGELOG.md
Release Candidate:
* https://dist.apache.org/repos/dist/dev/skywalking/python/$VERSION
* sha512 checksums
- sha512xxxxyyyzzz skywalking-python-src-x.x.x.tgz
Release Tag :
* (Git Tag) v$VERSION
Release Commit Hash :
* https://github.com/apache/skywalking-python/tree/<Git Commit Hash>
Keys to verify the Release Candidate :
* https://dist.apache.org/repos/dist/release/skywalking/KEYS
Guide to build the release from source :
* https://github.com/apache/skywalking-python/blob/master/CONTRIBUTING.md#compiling-and-building
Voting will start now and will remain open for at least 72 hours, all PMC members are required to give their votes.
[ ] +1 Release this package.
[ ] +0 No opinion.
[ ] -1 Do not release this package because....
Thanks.
[1] https://github.com/apache/skywalking/blob/master/docs/en/guides/How-to-release.md#vote-check
Vote Check
All PMC members and committers should check these before voting +1:
- Features test.
- All artifacts in staging repository are published with
.asc
,.md5
, andsha
files. - Source codes and distribution packages (
skywalking-python-src-$VERSION.tgz
) are inhttps://dist.apache.org/repos/dist/dev/skywalking/python/$VERSION
with.asc
,.sha512
. LICENSE
andNOTICE
are in source codes and distribution package.- Check
shasum -c skywalking-python-src-$VERSION.tgz.sha512
. - Check
gpg --verify skywalking-python-src-$VERSION.tgz.asc skywalking-python-src-$VERSION.tgz
. - Build distribution from source code package by following this the build guide.
- Licenses check,
make license
.
Vote result should follow these:
-
PMC vote is +1 binding, all others is +1 no binding.
-
Within 72 hours, you get at least 3 (+1 binding), and have more +1 than -1. Vote pass.
-
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:
[RESULT][VOTE] Release Apache SkyWalking Python version $VERSION 72+ hours passed, we’ve got ($NUMBER) +1 bindings (and ... +1 non-bindings): (list names) +1 bindings: xxx ... +1 non-bindings: xxx ... Thank you for voting, I’ll continue the release process.
Publish release
-
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.svn mv https://dist.apache.org/repos/dist/dev/skywalking/python/"$VERSION" https://dist.apache.org/repos/dist/release/skywalking/python/"$VERSION"
-
Refer to the previous PR, 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.
- Make sure the final upload is correct by using the test PyPI index
make upload-test
. - 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, 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.
See How-to-release-docker for a detailed description of manual release.
-
Send ANNOUNCEMENT email to
dev@skywalking.apache.org
andannounce@apache.org
, the sender should use his/her Apache email account.Subject: [ANNOUNCEMENT] Apache SkyWalking Python $VERSION Released Content: Hi the SkyWalking Community On behalf of the SkyWalking Team, I’m glad to announce that SkyWalking Python $VERSION is now released. SkyWalking Python: The Python Agent for Apache SkyWalking provides the native tracing/metrics/logging/profiling abilities for Python projects. SkyWalking: APM (application performance monitor) tool for distributed systems, especially designed for microservices, cloud native and container-based (Docker, Kubernetes, Mesos) architectures. Download Links: http://skywalking.apache.org/downloads/ Release Notes : https://github.com/apache/skywalking-python/blob/v$VERSION/CHANGELOG.md Website: http://skywalking.apache.org/ SkyWalking Python Resources: - Issue: https://github.com/apache/skywalking/issues - Mailing list: dev@skywalking.apache.org - Documents: https://github.com/apache/skywalking-python/blob/v$VERSION/README.md The Apache SkyWalking Team