Skip to content

docs: Add missing uki-addons output artifacts item type#615

Open
vinceaperri wants to merge 3 commits into
mainfrom
user/vinceaperri/docs-uki-addons
Open

docs: Add missing uki-addons output artifacts item type#615
vinceaperri wants to merge 3 commits into
mainfrom
user/vinceaperri/docs-uki-addons

Conversation

@vinceaperri
Copy link
Copy Markdown
Contributor

No description provided.

@vinceaperri vinceaperri requested a review from a team as a code owner March 4, 2026 18:51

- `ukis` – UKI PE images (`vmlinuz-<version>.efi`) and their associated addon files
(`vmlinuz-<version>.efi.extra.d/vmlinuz-<version>.addon.efi`).
- `uki-addons` – UKI addon files only (`vmlinuz-<version>.addon.efi`), without
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This was added to InjectArtifactMetadata.type. But in outputArtifacts.type, uki includes UKI addons.

Copy link
Copy Markdown
Contributor Author

@vinceaperri vinceaperri Mar 5, 2026

Choose a reason for hiding this comment

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

I see. It's currently a valid option the user can specify, so should it be removed from func (i OutputArtifactsItemType) IsValid(), or are there plans for it to be in user configs in the future?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

For now, it is an invalid option for .output.artifacts[].type, since specifying uki will also output UKI addons. But it should remain a valid option for inject-files.


- `ukis` – UKI PE images (`vmlinuz-<version>.efi`) and their associated addon files
(`vmlinuz-<version>.efi.extra.d/vmlinuz-<version>.addon.efi`).
- `uki-addons` – UKI addon files only (`vmlinuz-<version>.addon.efi`), without
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I think the four items that actually trigger artifact extraction are ukis, shim, systemd-boot but no block for uki-addons. There is a OutputArtifactsItemUkiAddons constant is only used as an internal metadata type tag when addon files are discovered during ukis processing.

@vinceaperri vinceaperri force-pushed the user/vinceaperri/docs-uki-addons branch from 1e9a07a to a354bde Compare April 14, 2026 16:14
OutputArtifactsItemDefault OutputArtifactsItemType = ""
)

func (i OutputArtifactsItemType) IsValid() error {
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Is any product code calling the OutputArtifactsItemType.IsValid() function?

func TestOutputArtifactsItemTypeIsValidOutputItem_UkiAddons_Fail(t *testing.T) {
err := OutputArtifactsItemUkiAddons.IsValidOutputItem()
assert.Error(t, err)
assert.ErrorContains(t, err, "uki-addons are automatically included with ukis")
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I am not seeing the uki-addons are automatically included with ukis error in the IsValidOutputItem function.

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