particle-os/debian-forge-cli
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

README: document the new --extra-artifacts=sbom option

Browse source 
Small commit that tweaks the README to include this new option.
This commit is contained in:
Michael Vogt 2025-01-17 12:55:21 +01:00 • committed by Simon de Vlieger
parent cc2d1ac692
commit ca0c9e63bd
2 changed files with 19 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

3
.spellcheck-en-custom.txt
View file

@ -14,4 +14,7 @@ qcow
UEFI UEFI
datadir datadir
copr copr
SBOM
SBOMs
spdx
toml toml

16
README.md
View file

@ -42,6 +42,8 @@ $ sudo dnf install osbuild osbuild-depsolve-dnf
## Examples ## Examples
### Listing
To see the list of buildable images run: To see the list of buildable images run:
```console ```console
$ image-builder list-images $ image-builder list-images
@ -52,6 +54,8 @@ rhel-10.0 type:ami arch:x86_64
... ...
``` ```
### Building
To actually build an image run: To actually build an image run:
```console ```console
$ sudo image-builder build qcow2 --distro centos-9 $ sudo image-builder build qcow2 --distro centos-9
@ -60,6 +64,8 @@ $ sudo image-builder build qcow2 --distro centos-9
this will create a directory `centos-9-qcow2-x86_64` under which the this will create a directory `centos-9-qcow2-x86_64` under which the
output is stored. output is stored.
### Blueprints
Blueprints are supported, first create a `config.toml` and put e.g. Blueprints are supported, first create a `config.toml` and put e.g.
the following content in: the following content in:
```toml ```toml
@ -80,6 +86,14 @@ $ sudo image-builder build qcow2 --blueprint ./config.toml --distro centos-9
... ...
``` ```
### SBOMs
It is possible to generate spdx based SBOM (software bill of materials)
documents as part of the build. Just pass `--extra-artifacts=sbom` and
it will put them into the output directory.
### Filtering
When listing images, it is possible to filter: When listing images, it is possible to filter:
```console ```console
$ image-builder list-images --filter ami $ image-builder list-images --filter ami
@ -105,6 +119,8 @@ The following filters are currently supported, shell-style globbing is supported
* type: the image type name (e.g. qcow2) * type: the image type name (e.g. qcow2)
* bootmode: the bootmode (legacy, UEFI, hybrid) * bootmode: the bootmode (legacy, UEFI, hybrid)
### Output control
The output can also be switched, supported are "text", "json": The output can also be switched, supported are "text", "json":
```console ```console
$ image-builder list-images --output=json $ image-builder list-images --output=json