[GitHub] mrutkows closed pull request #4: Add the description of this repository into README

[GitBox <gi...@apache.org>]

mrutkows closed pull request #4: Add the description of this repository into README
URL: https://github.com/apache/incubator-openwhisk-release/pull/4
 
 
   

This is a PR merged from a forked repository.
As GitHub hides the original diff on merge, it is displayed below for
the sake of provenance:

As this is a foreign pull request (from a fork), the diff is supplied
below (as it won't show otherwise due to GitHub magic):

diff --git a/.travis.yml b/.travis.yml
index 2cd1331..4147f1a 100644
--- a/.travis.yml
+++ b/.travis.yml
@@ -2,11 +2,6 @@ sudo: required
 
 group: deprecated-2017Q3
 
-language: scala
-
-scala:
-   - 2.11.8
-
 services:
   - docker
 
diff --git a/README.md b/README.md
index 47c3c02..51c2a00 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,42 @@
-# incubator-openwhisk-release
+# OpenWhisk Graduate and Release Management
+[![License](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](http://www.apache.org/licenses/LICENSE-2.0)
+[![Build Status](https://travis-ci.org/apache/incubator-openwhisk-release.svg?branch=master)](https://travis-ci.org/apache/incubator-openwhisk-release)
+
+This project is responsible for the Release Management of OpenWhisk projects, by automating the processes of verifying
+the source code, building & deploying OpenWhisk, packaging the source code and binaries, publishing the artifacts to
+the specified online directories, etc. OpenWhisk is a serverless event-based programming service and currently an Apache
+Incubator project. The ultimate goal of this project is to guarantee the compliance with the Apache release requirements
+for OpenWhisk projects.
+
+We use Travis CI as the automated integration build tool to streamline the release process of OpenWhisk. Stages can be
+applied to build different jobs, which are able to run either in sequential or parallel. Artifacts can be shared across
+different jobs by using cache in Travis, as different jobs run on different virtual machines.
+
+# How to release an Apache project
+
+## Release Approval
+Apache requires a minimum of three positive votes and more positive than negative votes MUST be cast, in order to release.
+Release manager of OpenWhisk sends a release note to the OpenWhisk mailing for votes, and opens the mail for 72 hours.
+We can create JIRA issue for this release and close it when the requirement is met and ready for release. This step can
+be done manually by the release manager, beyond the scope of this project.
+
+An example of the release note can be found at the following link: [example of release note](https://github.com/apache/cordova-coho/blob/master/docs/coho-release-process.md).
+
+## Artifacts
+We need to package the source code and the complied binaries separately. Each of them should be signed cryptographically.
+The package of source code needs to provide the installation script for users to deploy a full OpenWhisk environment.
+We target to implement this step in Travis build.
+
+## Licensing
+All the source code has to be compliant with Apache Licensing Policy, by adding the LICENSE file, NOTICE file to each
+repository and the release package, and adding Licensing headers to each source code file.
+
+## Release distribution
+We need to upload all artifacts to project?s subdirectory in Apache channel. This step needs to be implemented in Travis build.
+
+# Reference
+[Apache release policy](http://www.apache.org/legal/release-policy.html)
+
+# Important Note
+There can be some missing steps in the release process described above for Apache projects, which will be implemented in
+future. We welcome any comments and contributions.
diff --git a/tools/travis/config.json b/tools/travis/config.json
index 5226aa9..e4077f0 100644
--- a/tools/travis/config.json
+++ b/tools/travis/config.json
@@ -7,7 +7,7 @@
     "incubator-openwhisk-wskdeploy"
   ],
   "incubator_openwhisk": {
-    "hash": "fc98e9a"
+    "hash": "a891e06"
   },
   "incubator_openwhisk_catalog": {
     "hash": "ad24d4c"


 

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services