README.md

pkg

Overview

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

Modules

Module	Import	Description
	go get github.com/defenseunicorns/pkg/helpers	Common helper functions for Go.
	go get github.com/defenseunicorns/pkg/oci	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 commands.

# Run all formatters
make fmt

# Run all linters
make lint

# Run all tests
make test

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

# Run all formatters for the helpers module
make fmt-helpers

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

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