id: version-3.1.0_Chinese-how-to-release title: How to Prepare a Release original_id: how-to-release

这是SINGA的发布准备流程指南。

  1. 选择一个发布管理者。发布管理者（RM）是发布过程的协调者，他的签名文件（.asc）将会与发布一起上传。RM 生成 KEY (RSA 4096 位)并将其上传到公钥服务器，首先需要得到其他Apache用户对他的密钥的认可（签名），才能连接到信任网，RM需要先求助其他项目管理者帮忙认证他的密钥。如何生成密钥？

  2. 检查license。 FAQ; SINGA Issue

    • 代码库不能包含与APL不兼容的第三方代码。
    • 依赖项与APL兼容，GNU类license不兼容。
    • 我们编写的所有源文件都必须包含Apache license头：http://www.apache.org/legal/src-headers.html. 链接中有一个脚本可以帮助将这个头同步到所有文件。
    • 更新LICENSE文件。如果我们在发行包中包含了任何非APL的第三方代码，必须要在NOTICE文件的最后注明。

  3. 复查版本。检查代码和文档。

    • 编译过程无错误。
    • (尽可能地)包含进单元测试。
    • Conda包运行无误。
    • Apache网站上的在线文档是最新的。

  4. 准备好RELEASE_NOTES文件。包括以下项目，介绍，特性，错误（链接到JIRA或Github PR），变更，依赖列表，不兼容问题，可以按照这个例子来写。

  5. 打包候选版本。该版本应该打包成：apache-singa-VERSION.tar.gz。这个版本不应该包含任何二进制文件，包括git文件。但是CMake的编译依赖于git标签来获取版本号；要删除这个依赖，你需要手动更新CMakeLists.txt文件来设置版本号：

    # 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

    将软件包上传到stage repo。应包括tar文件、签名、KEY和SHA256校验和文件。MD5不再使用，详细规则在这里。阶段文件夹应该包括：

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

    创建这些文件并上传到stage svn repo的命令如下：

    # in singa repo
rm -rf .git
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. 通过发送电子邮件的方式进行投票。现举例如下：
   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
  1. 等待至少48小时的测试回复。任何PMC、提交者或贡献者都可以测试发布的功能，以及反馈。大家在投票+1之前应该检查这些。如果投票通过，则发送如下的结果邮件，否则，从头开始重复刚刚的步骤。

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: <names>

N non-binding +1s: <names>

No 0s or -1s.

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

  1. 将软件包上传至 https://dist.apache.org/repos/dist/release/singa/，以便distribution。

  2. 更新SINGA网站的下载页面。tar.gz 文件必须从镜像下载，使用 closer.cgi 脚本；其他工件必须从 Apache 主站点下载。更多细节请看这里。我们在之前的版本中得到的一些反馈。“下载页面必须只链接到正式发布的版本，所以不能包含到GitHub的链接”，“链接到KEYS, sig和Hash的链接不能使用dist.apache.org而应该使用 https://www.apache.org/dist/singa/...”“而且你只需要一个KEYS链接，而且应该描述如何使用KEYS+sig或Hash来验证下载。”

  3. 删除RC标签并编译conda包。

  4. 发布release信息：

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}