# Development Guide

## Building Kompose
### Build with `go`

- you need `go v1.5` or later
- You need to set export `GO15VENDOREXPERIMENT=1` environment variable
- If your working copy is not in your `GOPATH`, you need to set it accordingly.

```console
$ go build -tags experimental -o kompose ./cli/main
```

You need `-tags experimental` because the current bundlefile package of docker/libcompose is still experimental.

### Building binaries with make

- You need `make`

#### Build multi-platforms:
```console
$ make binary-cross
```

#### Build current platform only:
```console
$ make binary
```

## Workflow
### Fork the main repository

1. Go to https://github.com/kubernetes-incubator/kompose
2. Click the "Fork" button (at the top right)

### Clone your fork

The commands below require that you have $GOPATH. We highly recommended you put Kompose' code into your $GOPATH.

```console
mkdir -p $GOPATH/src/github.com/kubernetes-incubator
cd $GOPATH/src/github.com/kubernetes-incubator
git clone https://github.com/$YOUR_GITHUB_USERNAME/kompose.git
cd kompose
git remote add upstream 'https://github.com/kubernetes-incubator/kompose'
```

### Create a branch and make changes

```console
git checkout -b myfeature
# Make your code changes
```

### Keeping your development fork in sync

```console
git fetch upstream
git rebase upstream/master
```

Note: If you have write access to the main repository at github.com/kubernetes-incubator/kompose, you should modify your git configuration so that you can't accidentally push to upstream:

```console
git remote set-url --push upstream no_push
```

### Committing changes to your fork

```console
git commit
git push -f origin myfeature
```

### Creating a pull request

1. Visit https://github.com/$YOUR_GITHUB_USERNAME/kompose.git
2. Click the "Compare and pull request" button next to your "myfeature" branch.
3. Check out the pull request process for more details

## Glide, glide-vc and dependency management

Kompose uses `glide` to manage dependencies and `glide-vc` to clean vendor directory.
They are not strictly required for building Kompose but they are required when managing dependencies under the vendor/ tree.
If you want to make changes to dependencies please make sure that `glide` and `glide-vc` are installed and in your `$PATH`.

### Installing glide

There are many ways to build and host Go binaries. Here is an easy way to get utilities like `glide` and  `glide-vc` installed:

1. Ensure that Mercurial and Git are installed on your system. (some of the dependencies use the mercurial source control system). 
    Use `apt-get install mercurial git` or `yum install mercurial git` on Linux, or brew.sh on OS X, or download directly them directly.

2. Create a new GOPATH for your tools and install `godep`:

```console
export GOPATH=$HOME/go-tools
mkdir -p $GOPATH
go get -u github.com/Masterminds/glide
go get github.com/sgotti/glide-vc
```

3. Add this $GOPATH/bin to your path. Typically you'd add this to your ~/.profile:

```console
export GOPATH=$HOME/go-tools
export PATH=$PATH:$GOPATH/bin
```

Check that `glide` and `glide-vc` commands are working.

```console
glide --version

glide-vc -h
```

### Using glide

#### Adding new dependency
1. Update `glide.yml` file.
 Add new packages or subpackages to `glide.yml` depending if you added whole new package as dependency or 
 just new subpackage.

2. Run `glide update --strip-vendor` to get new dependencies.
   Than run `glide-vc --only-code --no-tests` to delete all unnecessary files from vendor.

3. Commit updated `glide.yml`, `glide.lock` and `vendor` to git.


#### Updating dependencies

1. Set new package version in  `glide.yml` file.

2. Run `glide update --strip-vendor` to update dependencies.
   Than run `glide-vc --only-code --no-tests` to delete all unnecessary files from vendor.


##### Updating Kubernetes and OpenShift
Kubernetes version depends on what version is OpenShift using.
OpenShift is using forked Kubernetes to carry some patches.
Currently it is not possible to use different Kubernetes version from version that OpenShift uses.
(for more see comments in `glide.yml`)