You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@systemml.apache.org by gw...@apache.org on 2017/11/08 00:32:20 UTC
systemml git commit: [SYSTEMML-848] Create Release Creation Process
doc
Repository: systemml
Updated Branches:
refs/heads/master 75b93f261 -> bc781fcef
[SYSTEMML-848] Create Release Creation Process doc
Closes #697.
Project: http://git-wip-us.apache.org/repos/asf/systemml/repo
Commit: http://git-wip-us.apache.org/repos/asf/systemml/commit/bc781fce
Tree: http://git-wip-us.apache.org/repos/asf/systemml/tree/bc781fce
Diff: http://git-wip-us.apache.org/repos/asf/systemml/diff/bc781fce
Branch: refs/heads/master
Commit: bc781fcef778bed9cb6bff686f841c3040297213
Parents: 75b93f2
Author: Arvind Surve <ac...@yahoo.com>
Authored: Tue Nov 7 16:29:58 2017 -0800
Committer: Glenn Weidner <gw...@us.ibm.com>
Committed: Tue Nov 7 16:29:58 2017 -0800
----------------------------------------------------------------------
docs/release-creation-process.md | 135 ++++++++++++++++++++++++++++++++++
docs/release-process.md | 9 +--
2 files changed, 138 insertions(+), 6 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/systemml/blob/bc781fce/docs/release-creation-process.md
----------------------------------------------------------------------
diff --git a/docs/release-creation-process.md b/docs/release-creation-process.md
new file mode 100644
index 0000000..edde97e
--- /dev/null
+++ b/docs/release-creation-process.md
@@ -0,0 +1,135 @@
+---
+layout: global
+title: SystemML Release Creation Process
+description: Description of the SystemML release build process.
+displayTitle: SystemML Release Creation Process
+---
+<!--
+{% comment %}
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements. See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to you under the Apache License, Version 2.0
+(the "License"); you may not use this file except in compliance with
+the License. You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+{% endcomment %}
+-->
+
+* This will become a table of contents (this text will be scraped).
+{:toc}
+
+#### Release Creation Guidelines Documentation
+Prerequisite: [Project release guidelines](https://github.com/SparkTC/development-guidelines/blob/master/project-release-guidelines.md)
+
+
+
+Tips to prepare and release the build
+
+Step 0. Minimum changes and verification to be done before release build process starts.
+
+ 1. ReadMe update and “Must Fix” changes are already in.
+ 2. Performance Test is passing for dataset size of 80GB and below.
+
+Step 1: Prepare the release
+
+ # Extract latest code to a directory
+ <GitRepoHome>
+
+ # Go to dev/release directory
+ cd <GitRepoHome>/dev/release
+
+ 1.a. Dry Run (This is trial build, will not commit anything in repository)
+
+ e.g. (On Master branch with release candidate rc1, release version 0.15.0, and next development version 1.0.0-SNAPSHOT)
+ ./release-build.sh --release-prepare --releaseVersion="0.15.0" --developmentVersion="1.0.0-SNAPSHOT" --releaseRc="rc1" --tag="v0.15.0-rc1" --dryRun
+
+ e.g. (On branch-0.15 branch with release candidate rc2, release version 0.15.0, and next development version 0.15.1-SNAPSHOT)
+ ./release-build.sh --release-prepare --releaseVersion="0.15.0" --developmentVersion="0.15.1-SNAPSHOT" --releaseRc="rc2" --tag="v0.15.0-rc2" --gitCommitHash="branch-0.15" --dryRun
+
+
+ 1.b. License verification<br>
+ ./release-verify.sh --verifyLic
+
+ 1.c. Run command to do release prepare step (This will commit changes to the repository)
+ This is same as step 1.a, without —dryRun option.<br>
+ e.g. (On the Master branch)<br>
+ ./release-build.sh --release-prepare --releaseVersion="0.15.0" --developmentVersion="1.0.0-SNAPSHOT" --releaseRc="rc1" --tag="v0.15.0-rc1"
+
+ e.g. (On the branch-0.15 branch)
+ ./release-build.sh --release-prepare --releaseVersion="0.15.0" --developmentVersion="0.15.1-SNAPSHOT" --releaseRc="rc2" --tag="v0.15.0-rc2" --gitCommitHash="branch-0.15"
+
+ 1.d Verify the release<br>
+ This will verify release on Mac Operating System (OS), assuming these steps are run on Mac OS. It will verify licenses, notice and all other required verification only on Mac OS.
+ Verification of licenses and notice is required only on one platform.
+
+ ./release-verify.sh --verifyAll
+
+
+Step 2: Publish the release
+
+ e.g.
+ ./release-build.sh --release-publish --gitTag="v0.15.0-rc1"
+
+
+Step 3: Close the release candidate build on Nexus site
+
+Visit [NexusRepository](https://repository.apache.org/#stagingRepositories) site.
+
+ Find out SystemML under (Staging Repositories) link. It should be in Open State (status). Close it (button on top left to middle) with proper comment.
+ Once it completes copying, URL will be updated with maven location to be sent in mail.
+
+Step 4. Send mail for voting (dev PMC) (dev@systemml.apache.org)
+
+Please check [Project release guidelines](https://github.com/SparkTC/development-guidelines/blob/master/project-release-guidelines.md)
+or previous mail thread for format/content of the mail.
+
+Step 5: Create a branch based on release to be released.
+ # Create a branch based on TAG
+ Syntax: git branch <branch name> <Tag Name>
+ e.g. git branch branch-0.15 v0.15.0-rc1
+
+ # Push a branch to master repository
+ Syntax: git push origin <branch name>
+ (origin is https://git-wip-us.apache.org/repos/asf/systemml.git)
+ e.g. git push origin branch-0.15
+
+
+Step 6: If there is failure to get votes then address issues and repeat from step 1.
+
+Step 7: If release has been approved, then make it available for general use for everyone.
+
+ 7.a Move distribution from dev to release (Run following commands from command line)
+
+ RELEASE_STAGING_LOCATION="https://dist.apache.org/repos/dist/dev/systemml/"
+ RELEASE_STAGING_LOCATION2="https://dist.apache.org/repos/dist/release/systemml/"
+
+ e.g. for SystemML 0.15 rc2 build
+ svn move -m "Move SystemML 0.15 from dev to release" $RELEASE_STAGING_LOCATION/0.15.0-rc2 $RELEASE_STAGING_LOCATION2/0.15.0
+
+
+ 7.b Move Nexus data from dev to release
+ Visit following site and identify release sent for voting in step 3 above. It would be in “closed” state (status).
+
+ https://repository.apache.org/#stagingRepositories
+
+ Click on “Release” button on top middle of the screen and complete the process.
+
+ Note: Release candidates which were not approved can be dropped by clicking “drop” button from top middle of the screen.
+
+ 7.c Update pypi from following site (Request someone who has the access)
+ https://pypi.python.org/pypi/systemml/
+
+ 7.d Update documents and release notes
+
+ 7.e Send ANNOUNCE NOTE
+ To: dev@systemml.apache.org announce@apache.org
+ Subject e.g.
+ [ANNOUNCE] Apache SystemML 0.15.0 released.
http://git-wip-us.apache.org/repos/asf/systemml/blob/bc781fce/docs/release-process.md
----------------------------------------------------------------------
diff --git a/docs/release-process.md b/docs/release-process.md
index d8d74f4..e5d0737 100644
--- a/docs/release-process.md
+++ b/docs/release-process.md
@@ -139,9 +139,7 @@ Verify that the snapshot is now available at
# Release Candidate Build and Deployment
-To be written. (Describe how the release candidate is built, including checksums. Describe how
-the release candidate is deployed to servers for review.)
-
+For detailed information, please see [SystemML Release Creation Process](release-creation-process.html).
# Release Candidate Checklist
@@ -377,7 +375,7 @@ For more information, please see [SystemML Performance Testing](python-performan
<a href="#release-candidate-checklist">Up to Checklist</a>
The unit tests for NN operators for GPU take a long time to run and are therefore not run as part of the Jenkins build.
-They must be run before a release. To run them, edit the
+They must be run before a release. To run them, edit the
[NeuralNetworkOpTests.java](https://github.com/apache/systemml/blob/master/src/test/java/org/apache/sysml/test/gpu/NeuralNetworkOpTests.java)
file and remove all the `@Ignore` annotations from all the tests. Then run the NN unit tests using mvn verify:
@@ -450,7 +448,7 @@ Generate pythondocs with Sphinx.
Copy contents of `systemml/target/pydocs/html` to `systemml-website-site/docs/1.0.0/api/python`.
-Open up `file:///.../systemml-website-site/docs/1.0.0/index.html` and verify `API Docs` → `Java` link works and that the correct Javadoc version is displayed.
+Open up `file:///.../systemml-website-site/docs/1.0.0/index.html` and verify `API Docs` → `Java` link works and that the correct Javadoc version is displayed.
Verify `API Docs` → `Python` link works and that the same Pythondoc version is displayed. Verify feedback links under `Issues` menu are not present.
Clean up any unnecessary files (such as deleting `.DS_Store` files on OS X).
@@ -488,4 +486,3 @@ Commit the update to `documentation.html` to publish the website update.
The versioned project documentation is now deployed to the main website, and the
[Documentation Page](http://systemml.apache.org/documentation) contains a link to the versioned documentation.
-