Skip to content

Latest commit

 

History

History
147 lines (94 loc) · 4.06 KB

development-guide.md

File metadata and controls

147 lines (94 loc) · 4.06 KB
Raw

Development Guide

This document walks you through how to get started developing OpenPitrix and development workflow.

Preparing the environment

Go

OpenPitrix development is written in Go. If you don't have a Go development environment, please set one up, GO requires >= 1.12.

Tips:

  • Ensure your GOPATH and PATH have been configured in accordance with the Go environment instructions.
  • It's recommended to install macOS GNU tools for Mac OS.

Dependency management

OpenPitrix uses dep to manage dependencies in the vendor/ tree, execute following command to install dep.

go get -u github.com/golang/dep/cmd/dep

Test

In the development process, it is recommended to install an single-node all-in-one environment (Kubernetes-based) for quick testing.

Tip: It also supports to use Docker for Desktop ships with Kubernetes as the test environment.

Development Workflow

1 Fork in the cloud

  1. Visit https://github.com/openpitrix/openpitrix
  2. Click Fork button to establish a cloud-based fork.

2 Clone fork to local storage

Per Go's [workspace instructions][https://golang.org/doc/code.html#Workspaces], place OpenPitrix' code on your GOPATH using the following cloning procedure.

  1. Define a local working directory:
$ export working_dir=$GOPATH/src/openpitrix.io
$ export user={your github profile name}
  1. Create your clone locally:
$ mkdir -p $working_dir
$ cd $working_dir
$ git clone https://github.com/$user/openpitrix.git
$ cd $working_dir/openpitrix
$ git remote add upstream https://github.com/openpitrix/openpitrix.git

# Never push to upstream master
$ git remote set-url --push upstream no_push

# Confirm that your remotes make sense:
$ git remote -v

3 Keep your branch in sync

git fetch upstream
git checkout master
git rebase upstream/master

4 Add new features or fix issues

Branch from it:

$ git checkout -b myfeature

Then edit code on the myfeature branch.

Run and test

$ make build
$ make compose-up

Run make help for additional information on these make targets.

5 Development in new branch

Sync with upstream

After the test is completed, suggest you to keep your local in sync with upstream which can avoid conflicts.

# Rebase your the master branch of your local repo.
$ git checkout master
$ git rebase upstream/master

# Then make your development branch in sync with master branch
git checkout new_feature
git rebase -i master

Commit local changes

$ git add <file>
$ git commit -s -m "add your description"

6 Push to your folk

When ready to review (or just to establish an offsite backup or your work), push your branch to your fork on github.com:

$ git push -f ${your_remote_name} myfeature

7 Create a PR

CI/CD

OpenPitrix uses Travis CI as a CI/CD tool.

The components of OpenPitrix under /cmd folder need to be compiled and build include following:

After your PR is merged，Travis CI will compile the entire project and build the image, and push the image openpitrix/[component-name]:latest to Dockerhub (e.g. openpitrix/openpitrix-api-gateway:latest)

Code conventions

Please reference Code conventions and follow with the rules.

Note:

  • All new packages and most new significant functionality must come with unit tests
  • Comment your code in English, see Go's commenting conventions