next

Edit

How to Prepare a Release

This is a guide for the release preparing process in SINGA.

  1. Select a release manager. The release manager (RM) is the coordinator for the release process. It is the RM's signature (.asc) that is uploaded together with the release. The RM generates KEY (RSA 4096-bit) and uploads it to a public key server. The RM needs to get his key endorsed (signed) by other Apache user, to be connected to the web of trust. He should first ask the mentor to help signing his key. How to generate the key?

  2. Check license. FAQ; SINGA Issue

    • The codebase does not include third-party code which is not compatible to APL;
    • The dependencies are compatible with APL. GNU-like licenses are NOT compatible;
    • All source files written by us MUST include the Apache license header: http://www.apache.org/legal/src-headers.html. There's a script in there which helps propagating the header to all files.
    • Update the LICENSE file. If we include any third party code in the release package which is not APL, must state it at the end of the NOTICE file.

  3. Bump the version. Check code and documentation

    • The build process is error-free.
    • Unit tests are included (as much as possible)
    • Wheel packages run without errors.
    • The online documentation on the Apache website is up to date.

  4. Prepare the RELEASE_NOTES file. Include the following items, Introduction, Features, Bugs (link to JIRA or Github PR), Changes, Dependency list, Incompatibility issues. Follow this example.

  5. Package the release candidate. The release should be packaged into : apache-singa-VERSION.tar.gz. The release should not include any binary files including git files. However, the CMake compilation depends on the git tag to get the version numbers; to remove this dependency, you need to manually update the CMakeLists.txt file to set the version numbers.

    # remove the following lines
include(GetGitRevisionDescription)
git_describe(VERSION --tags --dirty=-d)
string(REGEX REPLACE "^([0-9]+)\\..*" "\\1" VERSION_MAJOR "${VERSION}")
string(REGEX REPLACE "^[0-9]+\\.([0-9]+).*" "\\1" VERSION_MINOR "${VERSION}")
string(REGEX REPLACE "^[0-9]+\\.[0-9]+\\.([0-9]+).*" "\\1" VERSION_PATCH "${VERSION}")

# set the numbers manually
SET(PACKAGE_VERSION 3.0.0)
SET(VERSION 3.0.0)
SET(SINGA_MAJOR_VERSION 3)  # 0 -
SET(SINGA_MINOR_VERSION 0)  # 0 - 9
SET(SINGA_PATCH_VERSION 0)  # 0 - 99

    Upload the package to the stage repo. The tar file, signature, KEY and SHA256 checksum file should be included. MD5 is no longer used. Policy is here. The stage folder should include:

    • apache-singa-VERSION.tar.gz
    • apache-singa-VERSION.acs
    • apache-singa-VERSION.SHA256

    The commands to create these files and upload them to the stage svn repo:

    # in singa repo
rm -rf .git
rm -rf ./.gitignore
rm -rf ./.gitmodules
rm -rf rafiki/*
cd ..
tar -czvf apache-singa-VERSION.tar.gz  singa/

mkdir stage
cd stage
svn co https://dist.apache.org/repos/dist/dev/singa/
cd singa
# copy the KEYS file from singa repo to this folder if it is not here
cp ../../singa/KEYS .
mkdir VERSION
# copy the tar.gz file
mv ../../apache-singa-VERSION.tar.gz VERSION/
cd VERSION
sha512sum apache-singa-VERSION.tar.gz > apache-singa-VERSION.tar.gz.sha512
gpg --armor --output apache-singa-VERSION.tar.gz.asc --detach-sig apache-singa-VERSION.tar.gz
cd ..
svn add VERSION
svn commit

  1. Call for vote by sending an email. An example is provided as follows.

    To: dev@singa.apache.org
Subject: [VOTE] Release apache-singa-X.Y.Z (release candidate N)

Hi all,

I have created a build for Apache SINGA 3.1.0, release candidate 2.

The release note is at
https://github.com/apache/singa/blob/master/RELEASE_NOTES.

The artifacts to be voted on are located here:
https://dist.apache.org/repos/dist/dev/singa/3.1.0.rc2/apache-singa-3.1.0.rc2.tar.gz
 
The hashes of the artifacts are as follows:
SHA512: 84545499ad36da108c6a599edd1d853f82d331bc03273b5278515554866f0c698e881f956b2eabcb6b29c07fa9fa4ff1add5a777b58db8a6a2362cf383b5c04d 

Release artifacts are signed with the followingkey:
https://dist.apache.org/repos/dist/dev/singa/KEYS

The signature file is:
https://dist.apache.org/repos/dist/dev/singa/3.1.0.rc2/apache-singa-3.1.0.rc2.tar.gz.asc

The Github tag is at:
https://github.com/apache/singa/releases/tag/3.1.0.rc2

The documentation website is at
http://singa.apache.org/docs/next/installation/

Some examples are available for testing:
https://github.com/apache/singa/tree/master/examples

Please vote on releasing this package. The vote is open for at least 72 hours and passes if a majority of at least three +1 votes are cast.

[ ] +1 Release this package as Apache SINGA X.Y.Z [ ] 0 I don't feel strongly about it, but I'm okay with the release [ ] -1 Do not release this package because...

Here is my vote: +1


7) Wait at least 48 hours for test responses. Any PMC, committer or contributor
can test features for releasing, and feedback. Everyone should check these
before vote +1. If the vote passes, then send the result email. Otherwise,
repeat from the beginning.

To: dev@singa.apache.org Subject: [RESULT][vote] Release apache-singa-X.Y.Z (release candidate N)

Thanks to everyone who has voted and given their comments. The tally is as follows.

N binding +1s:

N non-binding +1s:

No 0s or -1s.

I am delighted to announce that the proposal to release Apache SINGA X.Y.Z has passed.


8) Upload the package for
[distribution](http://www.apache.org/dev/release-publishing.html#distribution)
to https://dist.apache.org/repos/dist/release/singa/.

9) Update the Download page of SINGA website. The tar.gz file MUST be downloaded
from mirror, using closer.cgi script; other artifacts MUST be downloaded from
main Apache site. More details
[here](http://www.apache.org/dev/release-download-pages.html). Some feedback
we got during the previous releases: "Download pages must only link to formal
releases, so must not include links to GitHub.", "Links to KEYS, sigs and
hashes must not use dist.apache.org; instead use
https://www.apache.org/dist/singa/...;", "Also you only need one KEYS link,
and there should be a description of how to use KEYS + sig or hash to verify
the downloads."

10) Remove the RC tag and compile the conda packages.

11) Publish the release information.

 ```
 To: announce@apache.org, dev@singa.apache.org
 Subject: [ANNOUNCE] Apache SINGA X.Y.Z released

 We are pleased to announce that SINGA X.Y.Z is released.

 SINGA is a general distributed deep learning platform
 for training big deep learning models over large datasets.
 The release is available at: http://singa.apache.org/downloads.html
 The main features of this release include XXX
 We look forward to hearing your feedback, suggestions,
 and contributions to the project.

 On behalf of the SINGA team, {SINGA Team Member Name}
 ```
Last updated on 10/26/2023
← How to Contribute to DocumentationGit Workflow →