Gitiles
Code Review Sign In
gerrit.opencord.org / voltha-api-server / 18123e55a732822bf8d55fbaf0142065dab6beba
commit18123e55a732822bf8d55fbaf0142065dab6beba[log] [tgz]
authorScott Baker <smbaker@gmail.com>Fri Oct 25 15:13:08 2019 -0700
committerScott Baker <smbaker@gmail.com>Mon Oct 28 12:14:14 2019 -0700
tree79b6b68eca041eb90dd90f3261ebcbc1fb69edd8
parent764798a3c7d55ee9a9507d4122743617bfbff068 [diff]
VOL-2169 Add LOCAL_LIB_GO and update README

Change-Id: Id749550a336716216f8fe84819f217ec1fed1794
2 files changed
tree: 79b6b68eca041eb90dd90f3261ebcbc1fb69edd8
  1. .gitignore
  2. Makefile
  3. README.md
  4. VERSION
  5. arouter.json
  6. cmd/
  7. docker/
  8. go.mod
  9. go.sum
  10. internal/
  11. vendor/
README.md

How to Build the Voltha api-server

Working with Go Dependencies

This project uses Go Modules https://github.com/golang/go/wiki/Modules to manage dependencies. As a local best pratice this project also vendors the dependencies. If you need to update dependencies please follow the Go Modules best practices and also perform the following steps before committing a patch:

go mod tidy
go mod verify
go mod vendor

Building with a Local Copy of voltha-protos or voltha-lib-go

If you want to build/test using a local copy or voltha-protos or voltha-lib-go this can be accomplished by using the environment variables LOCAL_PROTOS and LOCAL_LIB_GO. These environment variables should be set to the filesystem path where the local source is located, e.g.

LOCAL\_PROTOS=$HOME/src/voltha-protos
LOCAL\_LIB\_GO=$HOME/src/voltha-lib-go

When these environment variables are set the vendored versions of these packages will be removed from the vendor directory and replaced by coping the files from the specified locations to the vendor directory. NOTE: this means that the files in the vendor directory are no longer what is in the git repository and it will take manual git intervention to put the original files back.