Michael Vogt 8ae5b98d9d HACKING.md: add basic documentation for the development

This commit adds a basic HACKING.md that explains the bare mimimum
to get started, including `go test -short` to skip the expensive
tests.

Contains also a drive-by rename of the test dependency install
for the GH action.

2024-12-16 07:54:45 +00:00

963 B

Raw Blame History

Hacking on image-builder-cli

Hacking on image-builder should be fun and is easy.

We have unit tests and some integration testing.

Setup

To work on bootc-image-builder one needs a working Go environment. See go.mod.

To run the testsuite install the test dependencies as outlined in the github action under "Install test dependencies".

Code layout

The go source code of image-builder-cli is under ./cmd/image-builder. It uses the images library internally to generate the images. Unit tests (and integration tests where it makes sense) are expected to be part of every PR but we are happy to help if those are missing from a PR.

Build

Build by running:

$ go build ./cmd/image-builder/

Unit tests

Run the unit tests via:

$ go test -short ./...

There are some integration tests that can be run via:

$ go test ./...