jonpspri commented on a change in pull request #184: Create tarball for Nginx container in OpenWhisk as part of release deploy script URL: https://github.com/apache/incubator-openwhisk-cli/pull/184#discussion_r162770748
########## File path: README.md ########## @@ -4,65 +4,85 @@ # Disclaimer -This project is currently on an experimental stage. We periodically synchronize the source code and test cases of this -repository with the [CLI folder](https://github.com/apache/incubator-openwhisk/tree/master/tools/cli/go-whisk-cli) and the [test folder](https://github.com/apache/incubator-openwhisk/tree/master/tests) in OpenWhisk. The framework of test cases is under construction -for this repository. Please contribute to the [CLI folder](https://github.com/apache/incubator-openwhisk/tree/master/tools/cli/go-whisk-cli) in OpenWhisk for any CLI changes, before we officially announce the separation +This project is currently on an experimental stage. We periodically synchronize +the source code and test cases of this repository with the [CLI +folder](https://github.com/apache/incubator-openwhisk/tree/master/tools/cli/go-whisk-cli) +and the [test +folder](https://github.com/apache/incubator-openwhisk/tree/master/tests) in +OpenWhisk. The framework of test cases is under construction for this +repository. Please contribute to the [CLI +folder](https://github.com/apache/incubator-openwhisk/tree/master/tools/cli/go-whisk-cli) +in OpenWhisk for any CLI changes, before we officially announce the separation of OpenWhisk CLI from OpenWhisk. -The OpenWhisk Command Line Interface (OpenWhisk CLI) is a unified tool that provides a consistent interface to -interact with OpenWhisk services. With this tool to download and configure, you are able to manage OpenWhisk services -from the command line and automate them through scripts. - +The OpenWhisk Command Line Interface (OpenWhisk CLI) is a unified tool that +provides a consistent interface to interact with OpenWhisk services. With this +tool to download and configure, you are able to manage OpenWhisk services from +the command line and automate them through scripts. # Where to download the binary of OpenWhisk CLI -The OpenWhisk CLI is available on the release page: [click here to download](https://github.com/apache/incubator-openwhisk-cli/releases). -We currently have binaries available for Linux, Mac OS and windows under amd64 architecture. You can download the -binary, which fits your local environment. +The OpenWhisk CLI is available on the release page: [click here to +download](https://github.com/apache/incubator-openwhisk-cli/releases). We +currently have binaries available for Linux, Mac OS and windows under amd64 +architecture. You can download the binary, which fits your local environment. # How to build the binary locally -You can also choose to build the binaries locally from the source code with Go tool. +The OpenWhisk CLI is written in the Go language. You have two options to build +the binary locally: + +1. Compile in your logal Go environment, +2. Build using the packaged Gradle scripts (including the 'gogradle' plugin) + +## Build the binary with Go -Make sure that you have Go installed [installing Go](https://golang.org/doc/install), and `$GOPATH` is defined [Go development environment](https://golang.org/doc/code.html). +Make sure that you have Go installed [installing +Go](https://golang.org/doc/install), and `$GOPATH` is defined [Go development +environment](https://golang.org/doc/code.html). -Then download the source code of the OpenWhisk CLI and the dependencies by typing: +Then download the source code of the OpenWhisk CLI and the dependencies by +typing: ``` $ cd $GOPATH $ go get github.com/apache/incubator-openwhisk-cli ``` - -## Build the binary with Go - -Open an terminal, go to the directory of OpenWhisk CLI home directory, and build the binary via the following command: +Open an terminal, go to the directory of OpenWhisk CLI home directory, and build +the binary via the following command: ``` $ go build -o wsk ``` -If you would like to build the binary for a specific operating system, you may add the arguments GOOS and -GOARCH into the Go build command. Since it is only applicable under amd64 architecture, you have to set GOARCH -to amd64. GOOS can be set to "linux" "darwin" or "windows". +If you would like to build the binary for a specific operating system, you may +add the arguments GOOS and GOARCH into the Go build command. Since it is only +applicable under amd64 architecture, you have to set GOARCH to amd64. GOOS can +be set to "linux" "darwin" or "windows". For example, run the following command to build the binary for Linux: ``` $ GOOS=linux GOARCH=amd64 go build -o wsk ``` -If it is executed successfully, you can find your binary `wsk` directly under OpenWhisk CLI home directory. +If it is executed successfully, you can find your binary `wsk` directly under +OpenWhisk CLI home directory. -## Build the binary with Docker and Gradle +## Build the binary with Gradle -This is the second choice for you to build the binary. Make sure that you have Docker and gradle on your machine: -[installing Docker](https://docs.docker.com/engine/installation/) and [installing Gradle](https://gradle.org/install) for your local machine. +**Note:** For those who may have used the Gradle build previously, it has been +re-engineered to no longer required Docker or Go to be pre-installed on your +system. Using the [gogradle](https://github.com/gogradle/gogradle) plugin, the +script now uses a go environment if you have it, but will also create a local Review comment: D'oh (no d'oh). Fixed. ---------------------------------------------------------------- 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: [email protected] With regards, Apache Git Services
