Picking up source code

Edit the configuration file

The only file that a release manager needs to edit is the JSON-format configuration file named config.json under the folder tools. You can specify the the staging url, release url, the list of projects to be release, the repository url, branch name, and hash value of the source code for each project, etc.

Template of config.json:

{
  "publish_stage": "false",
  "stage_url": "https://dist.apache.org/repos/dist/dev/incubator/openwhisk",
  "release_url": "https://dist.apache.org/repos/dist/release/incubator/openwhisk",
  "versioning": {
    "version": "incubator",
    "pre_release_version": "rc1"
  },
  "RepoList": [
    "incubator-openwhisk",
    "incubator-openwhisk-wskdeploy",
    "incubator-openwhisk-cli"
  ],
  "incubator_openwhisk": {
    "hash": "a891e06",
    "repository": "https://github.com/apache/incubator-openwhisk.git",
    "branch": "master"
  },
  "incubator_openwhisk_wskdeploy": {
    "hash": "1425456",
    "repository": "https://github.com/apache/incubator-openwhisk-wskdeploy.git",
    "branch": "master"
  },
  "incubator_openwhisk_cli": {
    "hash": "1448d31",
    "repository": "https://github.com/apache/incubator-openwhisk-cli.git",
    "branch": "master"
  }
}

• publish_stage: the field to specify whether the Travis build in master will upload the new artifacts to the staging URL or not. If it is set to false, the Travis build in master will not upload the artifacts. If it is set to true, the Travis build in master will upload the artifacts.
• stage_url: the field to specify the staging url, where to upload the artifacts.
• release_url: the field to specify the Apache release directory url, where to finally release the artifacts.
• versioning: the key to define the release name, with both a version and a pre-release version name.
• RepoList: the key to define the list of OpenWhisk projects to be released. Based on this key, we need to add other keys below with each of them matching each project name. For example, we define three projects in RepoList, so we have three other keys below to match each project.
• <project_name>: the key used to match one OpenWhisk project. If there is any hyphen(-) sign in the project name, we need to convert it into underscore(_). Hash key defines the hash value, repository defines the url of the project repository, and branch defines the branch name in the project repository. We can precisely locate a version of the source code to pick up for the release.

Download the source code to a local directory

Run the following script to download source code based on the configuration in config.json:

$ ./download_source_code.sh

After this script is executed, a directory called openwhisk_release will be created under the home directory of openwhisk release tool, if it is not available. The directory openwhisk_release will save the output files, including the source code of all the OpenWhisk repositories, packages to be rleased, signature, checksums, etc, when we run any bash script of this release tool.

Checkout the subversion repository

We need to checkout the subversion repository for OpenWhisk to stage the artifacts with the following command:

$ ./checkout_svn.sh <SVN_USERNAME> <SVN_PASSWORD>

If you have configured your local SVN with the username and the password, you can run the above script without the parameters.

After running this command, a remote folder named openwhisk-$version will be created in the subversion repository if necessary, and checked out to the local folder openwhisk_release/openwhisk/openwhisk-$full_version. The value of $full_version is $version-$pre_release_version, as defined in config.json. This command can also be used to sync-up your local folder with the remote subversion folder.