Skip to content

bib: document details about {,bib}cmd{ManifestFromCobra,Build}#402

Merged
lzap merged 1 commit intoosbuild:mainfrom
mvo5:consolidate-code-docs
Dec 12, 2025
Merged

bib: document details about {,bib}cmd{ManifestFromCobra,Build}#402
lzap merged 1 commit intoosbuild:mainfrom
mvo5:consolidate-code-docs

Conversation

@mvo5
Copy link
Contributor

@mvo5 mvo5 commented Dec 11, 2025

The {,bib}CmdBuild and {,bib}ManifestFromCobra functions are
quite similar which raises the question what could be done
to share more code.

This commit documents the differences and why its hard to
consolidate them. Note that if we would add support for
anaconda-iso into bib via something like:
https://github.com/osbuild/image-builder-cli/compare/main...mvo5:consolidate-bib-anaconda-iso-wip?expand=1
we could remove some of this duplication, however this would
make the "generic" code a bit less nice (trade-offs!).

But other differences like the lack of renaming of the produced
results or the multi-export builds in bib are harder to
consolidate and probably not worth it (i.e. the generic code
becomes more ugly than the de-duplication niceness wins).

@mvo5 mvo5 requested a review from a team as a code owner December 11, 2025 14:14
@mvo5 mvo5 requested review from lzap, supakeen and thozza and removed request for a team December 11, 2025 14:14
The {,bib}CmdBuild and {,bib}ManifestFromCobra functions are
quite similar which raises the question what could be done
to share more code.

This commit documents the differences and why its hard to
consolidate them. Note that if we would add support for
anaconda-iso into bib via something like:
https://github.com/osbuild/image-builder-cli/compare/main...mvo5:consolidate-bib-anaconda-iso-wip?expand=1
we could remove some of this duplication, however this would
make the "generic" code a bit less nice (trade-offs!).

But other differences like the lack of renaming of the produced
results or the multi-export builds in bib are harder to
consolidate and probably not worth it (i.e. the generic code
becomes more ugly than the de-duplication niceness wins).
@mvo5 mvo5 force-pushed the consolidate-code-docs branch from 45047da to 0ff7e3a Compare December 11, 2025 20:21
@lzap lzap added this pull request to the merge queue Dec 12, 2025
Merged via the queue into osbuild:main with commit 5d61224 Dec 12, 2025
40 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants