fgksgf commented on a change in pull request #82: URL: https://github.com/apache/skywalking-python/pull/82#discussion_r526872293
########## File path: docs/How-to-release.md ########## @@ -0,0 +1,224 @@ +# 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 + +1. Close (if finished, or move to next milestone otherwise) all issues in the current milestone from [skywalking-python](https://github.com/apache/skywalking-python/milestones) and [skywalking](https://github.com/apache/skywalking/milestones), create a new milestone if needed. +2. Update [CHANGELOG.md](../CHANGELOG.md) and `version` in [setup.py](../setup.py). + + +## Add your GPG public key to Apache svn + +1. Upload your GPG public key to a public GPG site, such as [MIT's site](http://pgp.mit.edu:11371/). + +1. Log in [id.apache.org](https://id.apache.org/) and submit your key fingerprint. + +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.** + + +## Build and sign the source code package + +```shell +export VERSION=<the version to release> + +git clone --recurse-submodules g...@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 + +```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" + +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. + +```text +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 kezhenx...@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 `d...@skywalking.apache.org`. + +```text +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: + +1. Features test. +1. All artifacts in staging repository are published with `.asc`, `.md5`, and `sha` files. +1. Source codes and distribution packages (`skywalking-python-src-$VERSION.tgz`) +are in `https://dist.apache.org/repos/dist/dev/skywalking/python/$VERSION` with `.asc`, `.sha512`. +1. `LICENSE` and `NOTICE` are in source codes and distribution package. +1. Check `shasum -c skywalking-python-src-$VERSION.tgz.sha512`. +1. Check `gpg --verify skywalking-python-src-$VERSION.tgz.asc skywalking-python-src-$VERSION.tgz`. +1. Build distribution from source code package by following this [the build guide](#build-and-sign-the-source-code-package). +1. Licenses check, `make license`. + +Vote result should follow these: + +1. PMC vote is +1 binding, all others is +1 no binding. + +1. Within 72 hours, you get at least 3 (+1 binding), and have more +1 than -1. Vote pass. + +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: + + ``` + [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 + +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**. + + ```shell + 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. + +1. Update [Github release page](https://github.com/apache/skywalking-python/releases), follow the previous convention. + +1. Send ANNOUNCE email to `d...@skywalking.apache.org` and `annou...@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?d...@skywalking.apache.org). + + ``` + 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, which provides the native tracing abilities for Python project. + + SkyWalking: APM (application performance monitor) tool for distributed systems, especially designed for microservices, cloud native and container-based (Docker, Kubernetes, Mesos) architectures. + + Vote Thread: $VOTE_THREAD_PERMALINK Review comment: ok ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org
