pritidesai commented on a change in pull request #1114: URL: https://github.com/apache/openwhisk-wskdeploy/pull/1114#discussion_r578005021
########## File path: README.md ########## @@ -41,37 +59,79 @@ You can use this in addition to the OpenWhisk CLI. In fact, this utility uses t --- +## Downloading released binaries + +Binaries of `wskdeploy` are available for download on the project's GitHub release page: +- [https://github.com/apache/openwhisk-wskdeploy/releases](https://github.com/apache/openwhisk-wskdeploy/releases). + +For each release, we typically provide binaries built for Linux, Mac OS (Darwin) and Windows on the AMD64 architecture. However, we provide instructions on how to build your own binaries as well from source code with the Go tool. See [Building the project](#building-the-project). + +_If you are a Developer or Contributor, **we recommend building from the latest source code** from the project's master branch._ + +for end-users, please use versioned releases of binaries. +- [https://github.com/apache/openwhisk-wskdeploy/releases](https://github.com/apache/openwhisk-wskdeploy/releases) + +--- + +## Running ```wskdeploy``` + +Start by verifying the utility can display the command line help: +```sh +$ ./wskdeploy --help +``` + +then try deploying an OpenWhisk Manifest and Deployment file: +```sh +$ ./wskdeploy -m tests/usecases/triggerrule/manifest.yml -d tests/usecases/triggerrule/deployment.yml +``` + +--- + ## Building the project ### GoLang setup -The wskdeploy utility is a GoLang program so you will first need to [Download and install GoLang](https://golang.org/doc/install) onto your local machine. +The wskdeploy utility is a GoLang program so you will first need to [Download and install GoLang](https://golang.org/dl/) onto your local machine. + +> **Note** Go version 1.15 or higher is recommended Make sure your `$GOPATH` is defined correctly in your environment. For detailed setup of your GoLang development environment, please read [How to Write Go Code](https://golang.org/doc/code.html). +### Download the source code from GitHub -### Get the source code from GitHub +As the code is managed using GitHub, it is easiest to retrieve the code using the `git clone` command. -Once your environment is setup, download `wskdeploy` and its dependencies: +if you just want to build the code and do not intend to be a Contributor, you can clone the latest code from the Apache repository: ```sh -$ cd $GOPATH -$ go get github.com/apache/openwhisk-wskdeploy # see known issues below if you get an error -$ go get github.com/tools/godep # get the dependency manager +git clone [email protected]:apache/openwhisk-wskdeploy Review comment: wow, love the simplicity 👍 ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: [email protected]
