Gitiles
Code Review Sign In
gerrit.lfbroadband.org / voltha-openolt-adapter / e8e6fa236de1d77d8ebfbd92fa4be79ee3465795
commite8e6fa236de1d77d8ebfbd92fa4be79ee3465795[log] [tgz]
authorEric Ball <eball@linuxfoundation.org>Sat Jun 27 16:57:30 2026 -0700
committerEric Ball <eball@linuxfoundation.org>Tue Jul 21 08:47:14 2026 -0700
treebda02efbb900455a251d3feb0da725d22d47986d
parent98f0b4ca60cf76633d4e577f7a221f5119d8740f [diff]
[VOL-5495] Add full GHA suite

Combines verify, release, and dependabot workflows.

Signed-off-by: Eric Ball <eball@linuxfoundation.org>
Change-Id: I5a85b7feead8a66fbc1ec3d83cdba717413eb920
5 files changed
tree: bda02efbb900455a251d3feb0da725d22d47986d
  1. .github/
  2. .gitignore
  3. .gitreview
  4. .golangci.yml
  5. .pre-commit-config.yaml
  6. CODE_OF_CONDUCT.md
  7. Makefile
  8. README.md
  9. VERSION
  10. cmd/
  11. compose/
  12. config.mk
  13. docker/
  14. go.mod
  15. go.sum
  16. internal/
  17. makefiles/
  18. pkg/
  19. requirements.txt
  20. 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.