Gitiles
Code Review Sign In
gerrit.opencord.org / voltha-openolt-adapter / 9186b4dbc772df1385cfbe7d743a1cb7c9a1348f
commit9186b4dbc772df1385cfbe7d743a1cb7c9a1348f[log] [tgz]
authorJoey Armstrong <joey@opennetworking.org>Wed Oct 04 14:55:16 2023 -0400
committerJoey Armstrong <joey@opennetworking.org>Mon Oct 30 11:56:56 2023 -0400
tree6394123513e1818d3ecbaa6ced050e6afd434307
parent0897d47f7946fd646e2f1dd42f71348cd11ec749 [diff]
[VOL-5190] - consistent voltha-protos version for all repos

VERSION
-------
 o https://docs.voltha.org/master/overview/contributing.html?highlight=version#versioning

go.mod
go.sum
vendor/modules.txt
------------------
 o Bump version of repo:voltha-proto to latest published v5.4.10.

 o Files beneath the vendor/ directory are maintained automatically by tools.
   + https://go.dev/ref/mod#go-mod-vendor

 o Commands used to update, format and check files beneath vendor/
   + go mod edit -require [...]
   + go mod tidy
   + go mod vendor
   + make lint LOCAL_FIX_PERMS=1

Change-Id: I77e79f98e9083f72c5ffc29f4ab3d07a8cd8ef33
4 files changed
tree: 6394123513e1818d3ecbaa6ced050e6afd434307
  1. .gitignore
  2. .gitreview
  3. .golangci.yml
  4. CODE_OF_CONDUCT.md
  5. Makefile
  6. README.md
  7. VERSION
  8. cmd/
  9. compose/
  10. config.mk
  11. docker/
  12. go.mod
  13. go.sum
  14. internal/
  15. makefiles/
  16. pkg/
  17. vendor/
README.md

OpenOLT adapter

The OpenOLT adapter connects the VOLTHA core to an OLT device running the OpenOLT agent.

Development make targets

The Makefile contains many commands that are useful in development:

% make help

build                     : Alias for 'docker build'
clean                     : Removes any local filesystem artifacts generated by a build
distclean                 : Removes any local filesystem artifacts generated by a build or test run
docker-build-profile      : Build openolt adapter docker image with profiling enabled
docker-build              : Build openolt adapter docker image
docker-kind-load          : Load docker images into a KinD cluster
docker-push               : Push the docker images to an external repository
help                      : Print help for each Makefile target
lint-dockerfile           : Perform static analysis on Dockerfile
lint-mod                  : Verify the Go dependencies
lint                      : Run all lint targets
local-lib-go              : Copies a local version of the voltha-lib-go dependency into the vendor directory
local-protos              : Copies a local version of the voltha-protos dependency into the vendor directory
mod-update                : Update go mod files
sca                       : Runs static code analysis with the golangci-lint tool
test                      : Run unit tests

Some highlights:

  • It's recommended that you run the lint, sca, and test targets before submitting code changes.

  • The docker-* targets for building and pushing Docker images depend on the variables DOCKER_REGISTRY, DOCKER_REPOSITORY, and DOCKER_TAG as described in the CORD documentation

  • If you make changes the dependencies in the go.mod file, you will need to run make mod-update to update the go.sum and vendor directory.

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

If you want to build/test using a local copy of the voltha-protos or voltha-lib-go libraries 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.:

export LOCAL_PROTOS=/path/to/voltha-protos
export LOCAL_LIB_GO=/path/to/voltha-lib-go

Then run make local-protos and/or make local-lib-go as is appropriate to copy them into the vendor directory.

NOTE: That the files in the vendor directory are no longer what is in the most recent commit, and it will take manual git intervention to put the original files back.