Set up local development

If you want to work on ContainerHive you can do so, easily.

Before starting to develop make sure you have read the Contribution Guidelines.

Requirements

Make sure to install the following tools:

• Go
• GNU make
• Docker
• pre-commit

Run

go run ./cmd/ch/ -h

Test

Run tests and show the coverage report in your default browser.

make test-coverage-report

Run specific package tests:

go test ./internal/dependency/...

Skip integration tests:

go test -short ./...

Build

Build binaries for all platforms.

make build

Generate embedded resources

Required before building.

make generate

Preview documentation

Preview the properdocs documentation locally with hot-reload for changes.

pip install -r requirements-docs.txt
properdocs serve