Repository: incubator-hivemall Updated Branches: refs/heads/master 0b6225af4 -> d725b4342
Updated release guide Project: http://git-wip-us.apache.org/repos/asf/incubator-hivemall/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-hivemall/commit/d725b434 Tree: http://git-wip-us.apache.org/repos/asf/incubator-hivemall/tree/d725b434 Diff: http://git-wip-us.apache.org/repos/asf/incubator-hivemall/diff/d725b434 Branch: refs/heads/master Commit: d725b43422fa68b5ee89c5ad9785edb2a95baa60 Parents: 0b6225a Author: Makoto Yui <[email protected]> Authored: Fri Jan 5 23:40:19 2018 +0900 Committer: Makoto Yui <[email protected]> Committed: Fri Jan 5 23:40:19 2018 +0900 ---------------------------------------------------------------------- src/site/markdown/download.md | 2 +- src/site/markdown/release-guide.md | 373 +++++++++++++++++++++++++++++++- 2 files changed, 362 insertions(+), 13 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-hivemall/blob/d725b434/src/site/markdown/download.md ---------------------------------------------------------------------- diff --git a/src/site/markdown/download.md b/src/site/markdown/download.md index 8fcdcbf..4f150ec 100644 --- a/src/site/markdown/download.md +++ b/src/site/markdown/download.md @@ -23,7 +23,7 @@ Detailed ChangeLog of each version can be found in the JIRA link. | RELEASE | DATE | DESCRIPTION | COMMIT | DOWNLOAD | |:--------|:-----|:------------|:-------|:---------| -| [0.5.0](https://issues.apache.org/jira/secure/ReleaseNote.jspa?projectId=12320630&version=12342155) | 2017-11-xx | The first Apache release. There are tremendous changes since [v0.4.2-rc.2](https://github.com/myui/hivemall/releases/tag/v0.4.2-rc.2) which is the last release before entering Apache Incubator. | xxxxxxx | tar (digest pgp)<br/>zip (digest pgp) | +| [0.5.0-rc1](https://issues.apache.org/jira/secure/ReleaseNote.jspa?projectId=12320630&version=12342155) | 2018-01-xx | The first Apache release. There are tremendous changes since [v0.4.2-rc.2](https://github.com/myui/hivemall/releases/tag/v0.4.2-rc.2) which is the last release before entering Apache Incubator. | [e13c0b3](https://github.com/apache/incubator-hivemall/tree/v0.5.0-rc1) | [zip](https://dist.apache.org/repos/dist/dev/incubator/hivemall/0.5.0-incubating-rc1/hivemall-0.5.0-incubating-rc1-source-release.zip)<br/>( [md5](https://dist.apache.org/repos/dist/dev/incubator/hivemall/0.5.0-incubating-rc1/hivemall-0.5.0-incubating-rc1-source-release.zip.md5) / [pgp](https://dist.apache.org/repos/dist/dev/incubator/hivemall/0.5.0-incubating-rc1/hivemall-0.5.0-incubating-rc1-source-release.zip.asc) ) | | .. | .. | .. | .. | .. | Past releases of Apache Hivemall can be found in [this page](https://github.com/myui/hivemall/releases). http://git-wip-us.apache.org/repos/asf/incubator-hivemall/blob/d725b434/src/site/markdown/release-guide.md ---------------------------------------------------------------------- diff --git a/src/site/markdown/release-guide.md b/src/site/markdown/release-guide.md index a29a1a8..8eafee3 100644 --- a/src/site/markdown/release-guide.md +++ b/src/site/markdown/release-guide.md @@ -31,13 +31,13 @@ If it is your first time doing an Apache release, then there is some initial set 1. Notifying the community the overall plan for the release 2. Ensure JIRA Issues are appropriately tagged for the Release - - Ensure that all JIRA issues that are addressed in this release are marked with the release version in the `FixVersion` field of the issue. + - [Check this link](https://issues.apache.org/jira/browse/HIVEMALL-162?jql=project%20%3D%20HIVEMALL%20AND%20status%20in%20(Resolved%2C%20Closed)%20AND%20fixVersion%20%3D%20EMPTY) for `CLOSED/RESOLVED` issues that does not have `FixVersion`. + - Then, ensure that all JIRA issues that are addressed in this release are marked with the release version in the `FixVersion` field of the issue. [Here](https://issues.apache.org/jira/browse/HIVEMALL-157?jql=project%20%3D%20HIVEMALL%20AND%20status%20in%20(Resolved%2C%20Closed)%20AND%20fixVersion%20%3D%200.5.0) is an example for v0.5.0 release. -# Making a release - -## Update ChangeLog +## UPDATE CHANGELOG 1. Create a release note in JIRA following [this instructions](https://confluence.atlassian.com/adminjiraserver071/creating-release-notes-802592502.html). +2. Download a release note as `ChangeLog.html` using [JIRA](https://issues.apache.org/jira/secure/ConfigureReleaseNote.jspa?projectId=12320630). ## TEST YOUR SETTINGS @@ -46,20 +46,369 @@ Try installing locally artifacts with activation apache-release profile. The fol **Note:** _Apache Hivemall keeps compatibility to Java 7._ ```sh +# JDK 7 is required for packaging $ export JAVA_HOME=`/usr/libexec/java_home -v 1.7` -$ mvn validate -Pcompile-xgboost -$ mvn clean install -Papache-release + +# Install xgboost jar to Maven local repository +$ mvn -Pcompile-xgboost validate + +# Try to create artifacts +$ mvn -Papache-release clean install +``` + +Ensure that all unit tests passes. License check by Apache RAT (`mvn apache-rat:check`) will be ran by the above command. + +### Verify Signatures of Release Artifacts + +```sh +cd target/ +for file in `find . -type f -iname '*.asc'`; do + gpg --verify ${file} +done +``` + +## SNAPSHOT RELEASE + +### PREPARE YOUR POMS FOR RELEASE + +**1)** Switch to master syncing to ASF master + +```sh +$ git checkout master +$ git fetch +$ git pull # or, git reset --hard asf/master +``` + +**2)** Set version string for a snapshot + +```sh +$ version=X.Y.Z +# RC should start at 1 and increment if early release candidates fail to release +$ rc=1 +# $ echo "${version}-incubating-SNAPSHOT" + +$ ./bin/set_version.sh --pom --version "${version}-incubating-SNAPSHOT" +``` + +**Note:** _`--pom` option SHOULD only used for SNAPSHOT release._ + +```sh +$ git commit -a -m "Prepare for the next Snapshot release of X.Y.Z" +$ git push asf master +``` + +**3)** Perform a dryRun + +```sh +$ version=X.Y.Z +# RC should start at 1 and increment if early release candidates fail to release +$ rc=1 +$ next_version=X.(Y+1).Z + +# Confirm that version and rc is defined. +$ echo "Release version: ${version}-incubating-rc${rc}" +$ echo "Development version: ${next_version}-incubating-SNAPSHOT" + +$ mvn -Papache-release release:prepare \ +-DautoVersionSubmodules=true -DdryRun=true \ +-Darguments='-Dmaven.test.skip.exec=true' -DskipTests=true -Dmaven.test.skip=true \ +-Dtag=v${version}-rc${rc} -DreleaseVersion=${version}-incubating-rc${rc} -DdevelopmentVersion=${next_version}-incubating-SNAPSHOT +``` + +Please provide the next SNAPSHOT version for next release WITHOUT `-rcX` e.g., as follows: + +`What is the new development version for "Apache Hivemall"?: X.(Y+1).Z-incubating-SNAPSHOT` + +### PUBLISH A SNAPSHOT + +```sh +$ mvn deploy -Darguments='-Dmaven.test.skip.exec=true' -DskipTests=true -Dmaven.test.skip=true +``` + +**Note:** _You SHOULD verify the deployment under [the Maven Snapshot repository at Apache](https://repository.apache.org/content/repositories/snapshots/org/apache/hivemall/)._ + +## PREPARE THE RELEASE + +### BRANCH THE RELEASE + +**1)** Create a branch + +```sh +$ git checkout -b vX.Y.Z +``` + +**Note: ** _Branch name starts with `v` and does not include `-rcX`._ + +**2)** Send e-mail announcing the release branch + +``` +To: [email protected] +CC: [email protected] +Subject: New release branch X.Y.Z + +Hello Hivemall developers and friends, + +We now have a release branch for X.Y.Z release. Trunk has been bumped to X.Y.Z-SNAPSHOT. + + https://github.com/apache/incubator-hivemall/tree/vX.Y.Z + +I'll be going over the JIRAs to move every non-blocker from this release to the next release. Release voting will be posted soon. +``` + +### PREPARE A RELEASE + +**1)** Set a release version + +```sh +# $ version=X.Y.Z +# $ rc=1 + +# Confirm that version and rc is defined. +$ echo ${version}-incubating-rc${rc} +X.Y.Z-incubating-rc1 +``` + +**2)** Update version strings in source codes. + +```sh +$ ./bin/set_version.sh --version "${version}-incubating-rc${rc}" + +# Check list of files to be committed. +$ git stauts +$ git commit -a -m "Bumped version string to ${version}-incubating-rc${rc}" +``` + +**3)** Prepare sets the version numbers in POM, creates a tag, and pushes it to git. + +```sh +$ mvn -Papache-release release:clean release:prepare \ +-DautoVersionSubmodules=true -DdryRun=false \ +-Darguments='-Dmaven.test.skip.exec=true' -DskipTests=true -Dmaven.test.skip=true \ +-Dtag=v${version}-rc${rc} -DreleaseVersion=${version}-incubating-rc${rc} -DdevelopmentVersion=${next_version}-incubating-SNAPSHOT +``` + +**4)** Update version strings for the development deversion + +```sh +$ ./bin/set_version.sh --version "${next_version}-incubating-SNAPSHOT" + +# Check list of files to be committed. +$ git stauts +$ git commit --amend -a +``` + +**5)** Push release branch and tag to remote ASF repository + +```sh +# Push the release branch +$ git push asf v${version} + +# Push the release tag +$ git push asf v${version}-rc${rc} +``` + +## STAGE THE RELEASE FOR A VOTE + +The release will automatically be inserted into a temporary staging repository for you. + +```sh +$ mvn -Papache-release release:perform \ +-Darguments='-Dmaven.test.skip.exec=true' -DskipTests=true -Dmaven.test.skip=true \ +-Dgoals=deploy -DlocalRepoDirectory=. -DlocalCheckout=true +``` + +### Verify nexus release artifacts + +1. Verify the staged artifacts in the nexus repo + - Go to [https://repository.apache.org/](https://repository.apache.org/) and login + - Under `Build Promotion`, click `Staging Repositories` + - In the `Staging Repositories` tab there should be a line with profile `org.apache.hivemall` + - Navigate through the artifact tree and make sure that all javadoc, sources, tests, and jars have .asc (GPG signature) and .md5 files. Refer [the ASF page](http://www.apache.org/dev/release-signing.html#verifying-signature) for artifacts verification. +2. Close the nexus staging repo + - Check the box on in the first column of the row, and press the âCloseâ button to publish the repository at [https://repository.apache.org/content/repositories/orgapachehivemall-1001/](https://repository.apache.org/content/repositories/orgapachehivemall-1001/) (or a similar URL) + +### Attach signatures for shaded jars + +Shaded jars does not have signatures. So, attach signatures to them as follows: + +```sh +cd target/ + +# Sign to the artifacts created by maven-shade-plugin +for f in `ls hivemall-*-with-dependencies.jar`; do + gpg --armor --output ${f}.asc --detach-sig ${f} + gpg --print-md MD5 ${f} > ${f}.md5 + gpg --print-md SHA1 ${f} > ${f}.sha1 +done + +# Verify GPG sign +for file in `find . -type f -iname 'hivemall-*-with-dependencies.jar.asc'`; do + echo ${file} + gpg --verify ${file} + echo +done +``` + +### Upload the artifacts via subversion to a staging area + +- Prepare release artifacts in SVN repository + +```sh +# Checkout release SVN repository +$ mkdir -p dist/dev/incubator +$ cd dist/dev/incubator +$ svn co https://dist.apache.org/repos/dist/dev/incubator/hivemall/ +$ cd hivemall + +# Download release artifacts +$ wget -e robots=off --no-check-certificate \ + -r -np --reject=html,txt,tmp -nH --cut-dirs=7 \ + https://repository.apache.org/content/repositories/orgapachehivemall-1001/org/apache/hivemall/hivemall/${version}-incubating-rc${rc}/ + +# Put ChangeLog +$ cd ${version}-incubating-rc${rc} +# Put ChangeLog generated by JIRA +$ cp ~/Downloads/ChangeLog.html . + +# Put Shaded jars +$ cp ~/hivemall/target/hivemall-*-with-dependencies.jar* . +``` + +- Push release arfifacts to ASF svn repository + +```sh +# cd dist/dev/incubator/hivemall +# ls ${version}-incubating-rc${rc} + +svn add ${version}-incubating-rc${rc}/ +svn commit -m "Put hivemall version ${version}-incubating-rc${rc} artifacts" +``` + +- Check release artifacts are properly deployed in the SVN repository: [https://dist.apache.org/repos/dist/dev/incubator/hivemall/X.Y.Z-incubating-rcZ/](https://dist.apache.org/repos/dist/dev/incubator/hivemall/0.5.0-incubating-rc1/) + +## PPMC voting + +Create a VOTE email thread on `[email protected]` to record votes as replies. + ``` +To: [email protected] +CC: [email protected] +Subject: [VOTE] Apache Hivemall <release version> Release + +Hi all, + +Apache Hivmeall 0.5.0 release candidate #1 (the first Apache release!) is now available for a vote within dev community. + +Links to various release artifacts are given below. Please review and cast your vote. + + - The source tarball, including signatures, digests, ChangeLog, etc.: + https://dist.apache.org/repos/dist/dev/incubator/hivemall/0.5.0-incubating-rc1/ + - Sources for the release: + https://dist.apache.org/repos/dist/dev/incubator/hivemall/0.5.0-incubating-rc1/hivemall-0.5.0-incubating-rc1-source-release.zip + https://dist.apache.org/repos/dist/dev/incubator/hivemall/0.5.0-incubating-rc1/hivemall-0.5.0-incubating-rc1-source-release.zip.asc (PGP Signature) + https://dist.apache.org/repos/dist/dev/incubator/hivemall/0.5.0-incubating-rc1/hivemall-0.5.0-incubating-rc1-source-release.zip.md5 (MD5 Hash) + - Git tag for the release: + https://git-wip-us.apache.org/repos/asf?p=incubator-hivemall.git;a=shortlog;h=refs/tags/v0.5.0-rc1 + - The Nexus Staging URL: + https://repository.apache.org/content/repositories/orgapachehivemall-1001/ + - KEYS file for verification: + https://dist.apache.org/repos/dist/dev/incubator/hivemall/KEYS + - For information about the contents of this release, see: + https://dist.apache.org/repos/dist/dev/incubator/hivemall/0.5.0-incubating-rc1/ChangeLog.html + +You can find Podling releases policies in + https://incubator.apache.org/policy/incubation.html#releases + http://www.apache.org/legal/release-policy.html + +The vote will be open for at least 72 hours and until necessary number of votes are reached. +At lease three +1 from PPMC members are required and we welcome your vote. + +[ ] +1 approve (Release this package as Apache Hivemall 0.5.0-incubating-rc1) +[ ] +0 no opinion +[ ] -1 disapprove (and reason why) + +Here is my +1 (binding). + +Thanks, +Makoto +``` + +## IPMC Voting + +What if vote succeed, then vote in `[email protected]`. + +``` +To: [email protected] +Subject: [VOTE] Apache Hivemall <release version> Release + +Hi all, + +The Apache Hivemall community has voted on and approved a proposal to release Apache Hivemall 0.5.0-rc1 (the first Apache release). Apache Hivemall is a library for machine learning for Apache Hive/Spark/Pig, incubating since 2016-09-13. + +We now kindly request that the Incubator PMC members review and vote on this incubator release candidate. + +The PPMC vote thread is located here: + <link to the dev voting thread> + +Links to various release artifacts are given below. + + - The source tarball, including signatures, digests, ChangeLog, etc.: + https://dist.apache.org/repos/dist/dev/incubator/hivemall/0.5.0-incubating-rc1/ + - KEYS file for verification: + https://dist.apache.org/repos/dist/dev/incubator/hivemall/KEYS + - Git tag for the release: + https://git-wip-us.apache.org/repos/asf?p=incubator-hivemall.git;a=shortlog;h=refs/tags/v0.5.0-rc1 + - The Nexus Staging URL: + https://repository.apache.org/content/repositories/orgapachehivemall-1001/ + - For information about the contents of this release, see: + https://dist.apache.org/repos/dist/dev/incubator/hivemall/0.5.0-incubating-rc1/ChangeLog.html + +Please vote accordingly: + +[ ] +1 approve (Release this package as Apache Hivemall 0.5.0-incubating-rc1) +[ ] -1 disapprove (and reason why) + +The vote will be open for at least 72 hours. + +Thanks, +Makoto +on behalf of Apache Hivemall PPMC +``` + +Once 72 hours has passed (which is generally preferred) and/or at least three +1 (binding) votes have been cast with no -1 (binding) votes, send an email closing the vote and pronouncing the release candidate a success. + +``` +To: [email protected] +Subject: [RESULT][VOTE]: Apache Hivemall <release version> Release + +Hi all, + +The Apache Hivemall <release version> vote is now closed and has passed as follows: + + [number] +1 (binding) votes + [number] -1 (binding) votes + +The Apache Hivemall (incubating) community will proceed with the release. + +Thanks, +Makoto +on behalf of Apache Hivemall PPMC +``` + +## Finalize release + +### Update JIRA -License check by Apache RAT (`mvn apache-rat:check`) will be ran by the above command. +Update the JIRA versions page to close all issues, mark the version as `"released"`, and set the date to the date that the release was approved. You may also need to make a new release entry for the next release. +### Merge release branch for the next development iteration -## Create a branch for release +If IPMC vote succeed, then merge the release branch into the master branch. -## Create a Source Release +### Publish the websit -## Upload the Source Release +Update [download page](http://hivemall.incubator.apache.org/download.html) etc. -## Tag the release +### Announcing the release -## Staging artifacts in Maven +Make an announcement about the release on the `[email protected]`, `[email protected]`, `[email protected]`, and `[email protected]` list as per the Apache Announcement Mailing Lists page. \ No newline at end of file
