Skip to content

Latest commit

 

History

History
90 lines (61 loc) · 2.65 KB

development.md

File metadata and controls

90 lines (61 loc) · 2.65 KB
Raw
layout permalink title redirect_from
default
/development/
Development
/docs/development.md/
/docs/development/

Development Guide

Building Kompose

Read about building kompose here.

Workflow

Fork the main repository

  1. Go to https://github.com/kubernetes/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 the Kompose code into your $GOPATH.

git clone https://github.com/$YOUR_GITHUB_USERNAME/kompose.git $GOPATH/src/github.com/kubernetes/kompose
cd $GOPATH/src/github.com/kubernetes/kompose
git remote add upstream 'https://github.com/kubernetes/kompose'

Create a branch and make changes

git checkout -b myfeature
# Make your code changes

Keeping your development fork in sync

git fetch upstream
git rebase upstream/main

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

git remote set-url --push upstream no_push

Committing changes to your fork

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

Go Modules and dependency management

Kompose uses Go Modules to manage dependencies. If you want to introduce changes to dependencies, please ensure that go.mod and go.sum are updated properly.

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 a different Kubernetes version from the version that OpenShift uses. (for more see comments in go.mod)

Adding CLI tests

Kompose CLI tests run kompose convert with docker-compose files, and cross-check the k8s and OpenShift artifacts generated with the template files.

To generate CLI tests, please run make gen-cmd.

CI

For Kompose, we use numerous CI's: