openwhisk-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From mrutkow...@apache.org
Subject [incubator-openwhisk-release] branch master updated: Manual mode is promoted for official release (#280)
Date Thu, 16 May 2019 21:32:49 GMT
This is an automated email from the ASF dual-hosted git repository.

mrutkowski pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-openwhisk-release.git


The following commit(s) were added to refs/heads/master by this push:
     new c31c65d  Manual mode is promoted for official release (#280)
c31c65d is described below

commit c31c65d75fee102d53c6f51dcd023b5779bb259f
Author: Vincent <shou@us.ibm.com>
AuthorDate: Thu May 16 17:32:44 2019 -0400

    Manual mode is promoted for official release (#280)
    
    If you still want to use the automated mode, please do that it your
    own fork, with your credentials setup with the Travis configuration.
---
 docs/release_instructions.md | 14 ++++++++++++--
 1 file changed, 12 insertions(+), 2 deletions(-)

diff --git a/docs/release_instructions.md b/docs/release_instructions.md
index 194a1ee..fa7e12e 100644
--- a/docs/release_instructions.md
+++ b/docs/release_instructions.md
@@ -22,14 +22,18 @@
 # Release process
 
 This project offers the Apache OpenWhisk Release Manager two modes to release OpenWhisk projects:
-- **Manual mode** and
-- **Automated mode**
+- [**Manual mode**](#manual-mode-of-release-process)
+- [**Automated mode**](#automated-mode-of-release-process)
 
 _Manual mode_ makes sure that the release manager can download the source code of this repository,
and go through the release process by running scripts sequentially on a local machine, to
push the artifacts into the staging directory and eventually move them into the Apache release
directory.
 
 _Automated mode_ provides the release manager another option to walk through the Apache release
process by kicking off the Travis job to run the scripts. A release manager can choose either
way to publish the artifacts in the staging directory and the Apache release directory.
 
 ## Manual mode of Release Process
+
+If you work as a release manager on an official release for an OpenWhisk project, manual
mode is recommended for you to go
+through and understand all the necessary steps of Apache release process tailored for OpenWhisk.
+
   1. [Preparing for a release](prepare_release.md) - how to prepare OpenWhisk projects for
a release
   2. [Prerequisites](prerequisites.md) - steps that release manager needs to do before a
release
   3. [Picking up the source code](pick_up_source_code.md) - determine the branch and hash
value for each OpenWhisk project to release
@@ -53,6 +57,12 @@ _Automated mode_ provides the release manager another option to walk through
the
 
 ## Automated mode of Release Process
 
+As the single configuration file config.json can lead to code conflict and inconsistency,
if multiple OpenWhisk projects
+are releasing individually in parallel, this automated mode is not recommended for release
managers. However, if you still
+lean on to the convenience of Travis builds, please fork this repository, embed the credentials
you need in your fork, and
+run with the automated mode. Don't forget to refer to the manual mode from time to time,
because many steps there are not
+automated, like the voting process, release notes, tags for Github repositories, etc.
+
 The release manager can take full advantage of Travis CI to implement the release process.
The only manual step is to configure the release information, by editing the configuration
file _config.json_. Please refer to [edit configuration file](pick_up_source_code.md#edit-the-configuration-file)
for the information able to be configured.
 
 * **PR-based Travis build**: the Travis build triggered by a pull request. Each time the
file config.json is ready, release manager can submit a pull request to the master branch
of OpenWhisk release repository. Based on the result of the Travis build, we know whether
the configurations in config.json can be used as a candidate to release. This type of Travis
build will download the source code, generate the artifacts, sign the artifacts, install the
OpenWhisk services and run the test cases.


Mime
View raw message