Apache SkyWalking Satellite Release Guide

This documentation guides the release manager to release the SkyWalking Satellite 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-satellite and skywalking, create a new milestone if needed.
  2. Update CHANGES.md.

Add your GPG public key to Apache svn

  1. Upload your GPG public key to a public GPG site, such as MIT’s site.

  2. Log in id.apache.org and submit your key fingerprint.

  3. 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 git@github.com:apache/skywalking-satellite && cd skywalking-satellite
git tag -a "v$VERSION" -m "Release Apache SkyWalking-Satellite v$VERSION"
git push --tags
make release

In total, six files should be automatically generated in the directory: apache-skywalking-satellite-${VERSION}-bin.tgz, apache-skywalking-satellite-${VERSION}-src.tgz, and their corresponding asc, sha512 files.

Upload to Apache svn

svn co https://dist.apache.org/repos/dist/dev/skywalking/
mkdir -p skywalking/satellite/"$VERSION"
cp skywalking-satellite/apache-skywalking*.tgz skywalking/satellite/"$VERSION"
cp skywalking-satellite/apache-skywalking*.tgz.asc skywalking/satellite/"$VERSION"
cp skywalking-satellite/apache-skywalking-satellite*.tgz.sha512 skywalking/satellite/"$VERSION"

cd skywalking/satellite && svn add "$VERSION" && svn commit -m "Draft Apache SkyWalking-Satellite release $VERSION"

Make the internal announcement

Send an announcement email to dev@ mailing list, please check all links before sending the email.

Subject: [ANNOUNCEMENT] SkyWalking Satellite $VERSION test build available

Content:

The test build of SkyWalking Satellite $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-satellite/blob/$VERSION/CHANGES.md

Release Candidate:

 * https://dist.apache.org/repos/dist/dev/skywalking/satellite/$VERSION
 * sha512 checksums
   - sha512xxxxyyyzzz apache-skywalking-satellite-bin-x.x.x.tgz
   - sha512xxxxyyyzzz apache-skywalking-satellite-src-x.x.x.tgz

Release Tag :

 * (Git Tag) v$VERSION

Release Commit Hash :

 * https://github.com/apache/skywalking-satellite/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-satellite/blob/v$VERSION/docs/en/guides/contribution/How-to-release.md

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, please check all links before sending the email.

Subject: [VOTE] Release Apache SkyWalking Satellite version $VERSION

Content:

Hi the SkyWalking Community:
This is a call for vote to release Apache SkyWalking Satellite version $VERSION.

Release notes:

 * https://github.com/apache/skywalking-satellite/blob/$VERSION/CHANGES.md

Release Candidate:

 * https://dist.apache.org/repos/dist/dev/skywalking/satellite/$VERSION
 * sha512 checksums
   - sha512xxxxyyyzzz skywalking-satellite-x.x.x-src.tgz
   - sha512xxxxyyyzzz skywalking-satellite-x.x.x-bin.tgz

Release Tag :

 * (Git Tag) v$VERSION

Release Commit Hash :

 * https://github.com/apache/skywalking-satellite/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-satellite/blob/$VERSION/docs/en/guides/contribuation/How-to-release.md

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.
  2. All artifacts in staging repository are published with .asc, .md5, and sha files.
  3. Source codes and distribution packages (skywalking-satellite-$VERSION-{src,bin}.tgz) are in https://dist.apache.org/repos/dist/dev/skywalking/satellite/$VERSION with .asc, .sha512.
  4. LICENSE and NOTICE are in source codes and distribution package.
  5. Check shasum -c skywalking-satellite-$VERSION-{src,bin}.tgz.sha512.
  6. Check gpg --verify skywalking-satellite-$VERSION-{src,bin}.tgz.asc skywalking-satellite-$VERSION-{src,bin}.tgz.
  7. Build distribution from source code package by following this command, make build.
  8. Licenses check, make license.

Vote result should follow these:

  1. PMC vote is +1 binding, all others is +1 no binding.

  2. Within 72 hours, you get at least 3 (+1 binding), and have more +1 than -1. Vote pass.

  3. 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 Satellite version $VERSION
   
3 days 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.

    export SVN_EDITOR=vim
svn mv https://dist.apache.org/repos/dist/dev/skywalking/satellite/$VERSION https://dist.apache.org/repos/dist/release/skywalking/satellite

  2. Refer to the previous PR, update the event and download links on the website.

  3. Update Github release page, follow the previous convention.

  4. Push docker image to the Docker Hub, make sure you have the write permission for push image.

    make docker && make docker.push

  5. Send ANNOUNCE email to dev@skywalking.apache.org and announce@apache.org, the sender should use his/her Apache email account, please check all links before sending the email.

    Subject: [ANNOUNCEMENT] Apache SkyWalking Satellite $VERSION Released

Content:

Hi the SkyWalking Community

On behalf of the SkyWalking Team, I’m glad to announce that SkyWalking Satellite $VERSION is now released.

SkyWalking Satellite: A lightweight collector/sidecar could be deployed closing to the target monitored system, to collect metrics, traces, and logs.

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-satellite/blob/$VERSION/CHANGES.md

Website: http://skywalking.apache.org/

SkyWalking Satellite Resources:
- Issue: https://github.com/apache/skywalking/issues
- Mailing list: dev@skywalking.apache.org
- Documents: https://github.com/apache/skywalking-satellite/blob/$VERSION/README.md
   
The Apache SkyWalking Team

Remove Unnecessary Releases

Please remember to remove all unnecessary releases in the mirror svn (https://dist.apache.org/repos/dist/release/skywalking/), if you don’t recommend users to choose those version. For example, you have removed the download and documentation links from the website. If they want old ones, the Archive repository has all of them.