particle-os/debian-forge-cli
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
debian-forge-cli/HACKING.md
Florian Schüller 734c132500 prepare all syntax for linters and spellchecks
2025-01-07 12:29:58 +00:00

964 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 test suite 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 ./...