Skip to content

main: add {supported,required} bp options to describe-image#376

Merged
supakeen merged 1 commit intoosbuild:mainfrom
mvo5:image-info-supported-customizations
Dec 2, 2025
Merged

main: add {supported,required} bp options to describe-image#376
supakeen merged 1 commit intoosbuild:mainfrom
mvo5:image-info-supported-customizations

Conversation

@mvo5
Copy link
Contributor

@mvo5 mvo5 commented Nov 21, 2025

We have the {supported,required}_blueprint_options in our YAML for a while now, so high time to expose it via describe-image as its really useful.

Thanks to Tom for suggesting this!

@mvo5 mvo5 requested a review from tkoscieln November 21, 2025 09:09
@mvo5 mvo5 requested a review from a team as a code owner November 21, 2025 09:09
@mvo5 mvo5 requested review from bcl, lzap and supakeen and removed request for a team November 21, 2025 09:09
PartitionTable *disk.PartitionTable `yaml:"partition_table,omitempty"`

SupportedBpOptions []string `yaml:"supported_blueprint_options,omitempty"`
RequiredBpOptions []string `yaml:"required_blueprint_options,omitempty"`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Going to nitpick this but why not write out Blueprint.

A real question: should this be:

blueprint:
  required:
    - x
  supported:
    - x

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like this! If we change it here we should also change it in the distrodefs YAML though so that we are symmetrical. Ideally (and that is a kinda big dream) the output of describe-image could be used as the basis for our yaml image definitions so staying close should be our goal.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yea this should be our goal. We can do it here first and I'll take care of doing the same in the distro yamls later on :)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like the grouping. Let's do it.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated

@mvo5 mvo5 requested a review from achilleas-k November 24, 2025 08:18
mvo5 added a commit to mvo5/images that referenced this pull request Dec 1, 2025
This commit moves the `blueprint_{supported,required}_options`
into a new nested structure:
```yaml
    blueprint:
      supported_options:
        - ...
      required_options:
        - ...
```
this was suggested for `image-builder describe-image` in:
osbuild/image-builder-cli#376 (comment)
but we need to start here to keep things symetric.
mvo5 added a commit to mvo5/images that referenced this pull request Dec 1, 2025
This commit moves the `blueprint_{supported,required}_options`
into a new nested structure:
```yaml
    blueprint:
      supported_options:
        - ...
      required_options:
        - ...
```
this was suggested for `image-builder describe-image` in:
osbuild/image-builder-cli#376 (comment)
but we need to start here to keep things symetric.
github-merge-queue bot pushed a commit to osbuild/images that referenced this pull request Dec 1, 2025
This commit moves the `blueprint_{supported,required}_options`
into a new nested structure:
```yaml
    blueprint:
      supported_options:
        - ...
      required_options:
        - ...
```
this was suggested for `image-builder describe-image` in:
osbuild/image-builder-cli#376 (comment)
but we need to start here to keep things symetric.
We have the `blueprint:\n {supported,required}_options` in our
YAML for a while now, so high time to expose it via describe-image
as its really useful.

Thanks to Tom for suggesting this!
@mvo5 mvo5 force-pushed the image-info-supported-customizations branch from 4b9e495 to beae728 Compare December 2, 2025 07:57
@supakeen supakeen added this pull request to the merge queue Dec 2, 2025
Merged via the queue into osbuild:main with commit e32b0af Dec 2, 2025
38 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.

4 participants