Skip to content

Latest commit

 

History

History
54 lines (29 loc) · 2.49 KB

build.md

File metadata and controls

54 lines (29 loc) · 2.49 KB
Raw

Building from Source

Prerequisites:

  • go version 1.12 or higher is installed and in the path
  • docker is installed and running
  • wget is installed

After setting the GOPATH env var correctly, just run make <action...> from the command line, within the same directory where Makefile resides. For example make package clean will run the package and then the clean actions.

Some of the scripts have conditional paths, because certain Linux commands behave differently on OS/X and elsewhere (fun).

What gets produced by the build?

Quite a bit of stuff.

Here's a description of the various artifacts as you would see them in a release page:

  • The actual RPM package for RHEL/Centos (to be yummed or rpm -i)

  • The binaries tarred up in the way homebrew loves them

  • The plain binaries tarred up as they come out of the build process

** for OS/X

** for Linux

** for Windows

  • The homebrew Formula (which we should push to some git repo, once we go "public")

  • The Debian package for Ubuntu-like Linux (to be apt-get installed)

  • Some other stuff that's always there

Running the CLI

So, you built from source and you would like to run it.

  • The first thing you need to do is to extract the binary for your OS from the ./package directory. Un-tar the file that matches your OS.

  • Next, you need to copy that file to some place that's in your $PATH (for example, /usr/bin or /usr/local/bin) or %PATH% (any Win folder, then add it to the %PATH%). You may also want to call it appsody, so that you can run the CLI just by typing appsody <command>.

  • Next, you need to build the appsody-controller (sorry). It's here: https://github.com/appsody/controller. Just build the binary, and move it to the /usr/local/Cellar/appsody/<release_tag>/appsody-controller. Call it appsody-controller (mandatory!) and make sure that it has +x permissions (also mandatory).

  • If you are replacing an old installation, you may want to delete the appsody home directory ($HOME/.appsody).

Travis build

The project is instrumented with Travis CI and with an appropriate Makefile. Most of the build logic is triggered from within the Makefile.

Upon commit, only the test and lint actions are executed by Travis.

In order for Travis to go all the way to package and deploy, you need to create a new release (one that is tagged with a never seen before tag). When you create a new release, a Travis build with automatically run, and the resulting artifacts will be posted on the Releases page.