pkg

Overview

pkg is the monorepo for common Go modules maintained by Defense Unicorns.

Modules

Module	Import	Description
	go get -u github.com/defenseunicorns/pkg/exec	provides a wrapper around the os/exec package
	go get -u github.com/defenseunicorns/pkg/helpers/v2	provides common helper functions for Go.
	go get -u github.com/defenseunicorns/pkg/kubernetes	provides helper functions related to Kubernetes.
	go get -u github.com/defenseunicorns/pkg/oci	provides tools for interacting with artifacts stored in OCI registries

Contributing

Follow the steps in CONTRIBUTING.md to contribute to this project.

Testing, Linting, and Formatting

View the Makefile for available targets.

# Run all formatters
make lint-fix

# Run all linters
make lint

# Run all tests
make test

To run any of the above against an individual module, append -<module name> to the target.

# Run all formatters for the helpers module
make lint-fix-helpers

# Run all linters for the helpers module
make lint-helpers

# Run all tests for the helpers module
make test-helpers