Tweak release scripts and polish the release doc (#8)
Signed-off-by: Gao Hongtao <hanahmily@gmail.com>
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index da6c8f9..e8eebd2 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -68,14 +68,14 @@
### Prerequisites
- [x] [GNU Make](https://www.gnu.org/software/make/manual/make.html) is installed
- [x] [GPG tool](https://gpgtools.org) is installed
-- [x] [Add your GPG key](docs/How-to-release.md#add-your-gpg-public-key)
+- [x] [Add your GPG key](doc/release.md#add-your-gpg-public-key)
### Release steps
-- Export the version that is to be released, `export VERSION=1.0.1 `
-- Tag the latest commit that is to be released with `git tag v${VERSION}` and push the tag with `git push https://github.com/apache/skywalking-swck v${VERSION}`
+- Export the version that is to be released, `export VERSION=0.1.0 `
+- Tag the latest commit that is to be released with `git tag ${VERSION}` and push the tag with `git push https://github.com/apache/skywalking-swck ${VERSION}`
- Verify licenses, build and sign distribution packages, simply run `make release`, distribution packages and checksums are generated
-- [Upload the packages to SVN repository](docs/How-to-release.md#upload-to-apache-svn)
-- [Send internal announcement](docs/How-to-release.md#make-the-internal-announcements)
-- [Wait at least 48 hours for test responses](docs/How-to-release.md#wait-at-least-48-hours-for-test-responses)
-- [Call for vote](docs/How-to-release.md#call-a-vote-in-dev)
-- [Publish release](docs/How-to-release.md#publish-release)
+- [Upload the packages to SVN repository](doc/release.md#upload-to-apache-svn)
+- [Send internal announcement](doc/release.md#make-the-internal-announcements)
+- [Wait at least 48 hours for test responses](doc/release.md#wait-at-least-48-hours-for-test-responses)
+- [Call for vote](doc/release.md#call-a-vote-in-dev)
+- [Publish release](doc/release.md#publish-release)
diff --git a/Makefile b/Makefile
index 897c5c2..9ea1d10 100644
--- a/Makefile
+++ b/Makefile
@@ -30,7 +30,10 @@
all: manager
clean:
- rm -rf bin/
+ rm -rf build/bin
+ rm -rf build/release
+ rm -rf *.out
+ rm -rf *.test
# Run tests
test: generate manifests
@@ -144,5 +147,11 @@
release-source:
${RELEASE_SCRIPTS} -s
+
+release-sign:
+ ${RELEASE_SCRIPTS} -k bin
+ ${RELEASE_SCRIPTS} -k src
-.PHONY: release-manager release-binary release-source
+release: release-binary release-source release-sign
+
+.PHONY: release-manager release-binary release-source release
diff --git a/build/package/release.sh b/build/package/release.sh
index 4f18db1..be60f32 100755
--- a/build/package/release.sh
+++ b/build/package/release.sh
@@ -22,7 +22,6 @@
ROOTDIR=${BUILDDIR}/..
RELEASE_TAG=$(git describe --tags $(git rev-list --tags --max-count=1))
-RELEASE_VERSION=${RELEASE_TAG#"v"}
binary(){
bindir=${BUILDDIR}/release/binary
@@ -36,38 +35,53 @@
# Generates CRDs and deployment manifests
kustomize build config/crd > ${bindir}/config/crds.yaml
pushd ${ROOTDIR}/config/manager
- kustomize edit set image controller=apache/skywalking-swck:${RELEASE_VERSION}
+ kustomize edit set image controller=apache/skywalking-swck:${RELEASE_TAG}
popd
kustomize build config/default > ${bindir}/config/deploy.yaml
# Package
- tar -czf ${BUILDDIR}/release/skywalking-swck-${RELEASE_VERSION}-bin.tgz -C ${bindir} .
+ tar -czf ${BUILDDIR}/release/skywalking-swck-${RELEASE_TAG}-bin.tgz -C ${bindir} .
+ rm -rf ${bindir}
}
source(){
# Package
- rm -rf ${BUILDDIR}/release/skywalking-swck-${RELEASE_VERSION}-src.tgz
+ rm -rf ${BUILDDIR}/release/skywalking-swck-${RELEASE_TAG}-src.tgz
pushd ${ROOTDIR}
tar \
+ --exclude=".DS_Store" \
+ --exclude=".git" \
+ --exclude=".github" \
+ --exclude=".gitignore" \
+ --exclude=".asf.yaml" \
+ --exclude=".idea" \
--exclude="bin" \
- --exclude="build" \
- --exclude=".*" \
+ --exclude="build/release" \
--exclude="*.test" \
--exclude="*.out" \
- -czf ${BUILDDIR}/release/skywalking-swck-${RELEASE_VERSION}-src.tgz \
+ -czf ./build/release/skywalking-swck-${RELEASE_TAG}-src.tgz \
.
popd
}
+sign(){
+ type=$1
+ pushd ${BUILDDIR}/release/
+ gpg --batch --yes --armor --detach-sig skywalking-swck-${RELEASE_TAG}-${type}.tgz
+ shasum -a 512 skywalking-swck-${RELEASE_TAG}-${type}.tgz > skywalking-swck-${RELEASE_TAG}-${type}.tgz.sha512
+ popd
+}
+
parseCmdLine(){
ARGS=$1
if [ $# -eq 0 ]; then
echo "Exactly one argument required."
usage
fi
- while getopts "bsh" FLAG; do
+ while getopts "bsk:h" FLAG; do
case "${FLAG}" in
b) binary ;;
s) source ;;
+ k) sign ${OPTARG} ;;
h) usage ;;
\?) usage ;;
esac
@@ -100,4 +114,3 @@
ret=$?
[ $ret -ne 0 ] && exit $ret
echo "Done release [$RELEASE_TAG] (exit $ret)"
-
diff --git a/doc/release.md b/doc/release.md
new file mode 100644
index 0000000..ed3fd7d
--- /dev/null
+++ b/doc/release.md
@@ -0,0 +1,222 @@
+# Apache SkyWalking Could on Kubernetes release guide
+
+This documentation guides the release manager to release the SkyWalking Cloud on Kubernetes 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-swck](https://github.com/apache/skywalking-swck/milestones) and [skywalking](https://github.com/apache/skywalking/milestones), create a new milestone if needed.
+2. Update [CHANGES.md](../CHANGES.md).
+
+
+## Add your GPG public key to Apache svn
+
+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 git@github.com:apache/skywalking-swck && cd skywalking-swck
+git tag -a "$VERSION" -m "Release Apache SkyWalking Cloud on Kubernetes $VERSION"
+git push --tags
+make clean && make release
+```
+
+The `skywalking-swck-${VERSION}-bin.tgz`, `skywalking-swck-${VERSION}-src.tgz`, and their corresponding `asc`, `sha512`. **In total, six files should be automatically generated in the directory.**
+
+## Upload to Apache svn
+
+```shell
+svn co https://dist.apache.org/repos/dist/dev/skywalking/
+mkdir -p skywalking/swck/"$VERSION"
+cp skywalking-swck/build/release/skywalking-swck*.tgz skywalking/swck/"$VERSION"
+cp skywalking-swck/build/release/skywalking-swck*.tgz.asc skywalking/swck/"$VERSION"
+cp skywalking-swck/build/release/skywalking-swck*.tgz.sha512 skywalking/swck/"$VERSION"
+
+cd skywalking/swck && svn add "$VERSION" && svn commit -m "Draft Apache SkyWalking-SWCK release $VERSION"
+```
+
+## Make the internal announcement
+
+Send an announcement email to dev@ mailing list.
+
+```text
+Subject: [ANNOUNCEMENT] SkyWalking Cloud on Kubernetes $VERSION test build available
+
+Content:
+
+The test build of SkyWalking Could on Kubernetes $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-swck/blob/$VERSION/CHANGES.md
+
+Release Candidate:
+
+ * https://dist.apache.org/repos/dist/dev/skywalking/swck/$VERSION
+ * sha512 checksums
+ - sha512xxxxyyyzzz apache-skywalking-swck-bin-x.x.x.tgz
+ - sha512xxxxyyyzzz apache-skywalking-swck-src-x.x.x.tgz
+
+Release Tag :
+
+ * (Git Tag) v$VERSION
+
+Release Commit Hash :
+
+ * https://github.com/apache/skywalking-swck/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-swck/blob/$VERSION/docs/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`
+
+```text
+Subject: [VOTE] Release Apache SkyWalking Could on Kubernetes version $VERSION
+
+Content:
+
+Hi the SkyWalking Community:
+This is a call for vote to release Apache SkyWalking Could on Kubernetes version $VERSION.
+
+Release notes:
+
+ * https://github.com/apache/skywalking-swck/blob/$VERSION/CHANGES.md
+
+Release Candidate:
+
+ * https://dist.apache.org/repos/dist/dev/skywalking/swck/$VERSION
+ * sha512 checksums
+ - sha512xxxxyyyzzz apache-skywalking-swck-src-x.x.x.tgz
+ - sha512xxxxyyyzzz apache-skywalking-swck-bin-x.x.x.tgz
+
+Release Tag :
+
+ * (Git Tag) v$VERSION
+
+Release Commit Hash :
+
+ * https://github.com/apache/skywalking-swck/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-swck/blob/v$VERSION/docs/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.
+1. All artifacts in staging repository are published with `.asc`, `.md5`, and `sha` files.
+1. Source codes and distribution packages (`apache-skywalking-swck-{src,bin}-$VERSION.tgz`)
+are in `https://dist.apache.org/repos/dist/dev/skywalking/swck/$VERSION` with `.asc`, `.sha512`.
+1. `LICENSE` and `NOTICE` are in source codes and distribution package.
+1. Check `shasum -c apache-skywalking-swck-{src,bin}-$VERSION.tgz.sha512`.
+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 Could on Kubernetes version $VERSION
+
+ 3 days passed, we’ve got ($NUMBER) +1 bindings:
+ xxx
+ xxx
+ xxx
+ ...
+ (list names)
+
+ 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
+ export SVN_EDITOR=vim
+ svn mv https://dist.apache.org/repos/dist/dev/skywalking/swck/$VERSION https://dist.apache.org/repos/dist/release/skywalking/swck
+ # ....
+ # enter your apache password
+ # ....
+ ```
+
+1. Refer to the previous [PR](https://github.com/apache/skywalking-website/pull/118), update news and links on the website. There are seven files need to modify.
+
+1. Update [Github release page](https://github.com/apache/skywalking-swck/releases), follow the previous convention.
+
+1. Send ANNOUNCE email to `dev@skywalking.apache.org` and `announce@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?dev@skywalking.apache.org).
+
+ ```
+ Subject: [ANNOUNCEMENT] Apache SkyWalking Could on Kubernetes $VERSION Released
+
+ Content:
+
+ Hi the SkyWalking Community
+
+ On behalf of the SkyWalking Team, I’m glad to announce that SkyWalking Could on Kubernetes $VERSION is now released.
+
+ SkyWalking Could on Kubernetes: A Command Line Interface for Apache SkyWalking.
+
+ 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
+
+ Download Links: http://skywalking.apache.org/downloads/
+
+ Release Notes : https://github.com/apache/skywalking-swck/blob/$VERSION/CHANGES.md
+
+ Website: http://skywalking.apache.org/
+
+ SkyWalking Could on Kubernetes Resources:
+ - Issue: https://github.com/apache/skywalking/issues
+ - Mailing list: dev@skywalkiing.apache.org
+ - Documents: https://github.com/apache/skywalking-swck/blob/$VERSION/README.md
+
+ The Apache SkyWalking Team
+ ```
+
+
\ No newline at end of file
