Gitiles
Code Review Sign In
gerrit.opencord.org / voltha-openonu-adapter-go / refs/tags/v2.11.3
tag872c201e3152c56ca553053610e7e2d6c19dce3f
taggerJenkins <do-not-reply@opennetworking.org>Tue Oct 31 18:28:03 2023 +0000
object77263085ee70025d1757030813dcb0d9fe6c018c 
Tagged by CORD Jenkins version-tag job: 498, for Gerrit patchset: 34807
commit77263085ee70025d1757030813dcb0d9fe6c018c[log] [tgz]
authorJoey Armstrong <joey@opennetworking.org>Mon Oct 30 12:38:34 2023 -0400
committerJoey Armstrong <joey@opennetworking.org>Mon Oct 30 12:38:34 2023 -0400
treeada38f7d9fa7c2cb74b017c7be74702cc6ace439
parent2d05f151534e1f81bf42a7f3700f642d7410df06 [diff]
[VOL-5190] - consistent voltha-protos version for all repos

Re-create patch https://gerrit.opencord.org/c/voltha-openonu-adapter-go/+/34777.
patch-revert-for-VERSION-file-bump created a new patch and original is unusable
due to merge status no longer allows git commit -amend.

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: I643ab796b45585f366d71935d7cecace5ff4e2bc
4 files changed
tree: ada38f7d9fa7c2cb74b017c7be74702cc6ace439
  1. .gitignore
  2. .gitreview
  3. .golangci.yml
  4. Makefile
  5. README.md
  6. VERSION
  7. cmd/
  8. docker/
  9. docs/
  10. go.mod
  11. go.sum
  12. internal/
  13. makefiles/
  14. pkg/
  15. templates/
  16. vendor/
README.md

OpenONU adapter

The OpenONU adapter provides communication capabilities via OMCI to the ONU devices to be managed by the voltha system.

Additional documentation can be found in docs

Development make targets

The Makefile contains many commands that are useful in development:

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              : Build openonu adapter docker image (set BUILD_PROFILED=true to also build the profiled 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                      : Run all lint targets
lint-mod                  : Verify the Go dependencies
lint-sanity               : Perform basic code checks on source
lint-style                : Perform lint style checks on source code
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.