Skip to content

fix: repair main after component-groups metadata + overlay-metadata API drift #274

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
liunan-ms merged 1 commit into from
Jul 10, 2026
Merged

fix: repair main after component-groups metadata + overlay-metadata API drift #274

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions docs/user/reference/config/component-groups.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,14 +15,14 @@ Component groups organize related components together and let you apply shared d

## Metadata

The optional `[component-groups.<name>.metadata]` table documents the group's intent and provenance. It shares exactly the same fields and validation rules as [overlay metadata](overlays.md): a required `category`, plus optional commit/bug links and an upstreamable assessment. It is documentation only — it does not affect how members are resolved or built.
The optional `[component-groups.<name>.metadata]` table documents the group's intent and provenance. It shares exactly the same fields and validation rules as [overlay metadata](overlays.md): a required `category`, a required `upstream-status`, and optional commit/bug links. It is documentation only — it does not affect how members are resolved or built.

| Field | TOML Key | Type | Required | Description |
|-------|----------|------|----------|-------------|
| Category | `category` | enum | **Yes** | Classification of the group's intent (e.g. `backport-dist-git`, `azl-disable-flaky-tests`) |
| Commits | `commits` | string array (URLs) | No | Upstream commit URLs this group references; required when `category = "backport-dist-git"` |
| Bugs | `bugs` | array of `{ url = "..." }` tables | No | References to related issue-tracker entries; see [Bug references](overlays.md#bug-references) |
| Upstreamable | `upstreamable` | boolean | No | Whether the group's change can be upstreamed (`true`/`false`); omit when not yet assessed |
| Category | `category` | enum | **Yes** | Classification of the group's intent (e.g. `upstream-backport`, `azl-disable-flaky-tests`); see [Categories](overlays.md#categories) for the full list |
| Upstream status | `upstream-status` | enum | **Yes** | Relationship to upstream (`upstreamed`, `upstreamable`, `needs-upstream-hook`, `inapplicable`, `unknown`); see [Upstream status](overlays.md#upstream-status). Must be `upstreamed` or `upstreamable` when `category = "upstream-backport"` |
| Commits | `commits` | array of `{ url = "..." }` tables | Sometimes | Upstream commit references this group backports; required when `category = "upstream-backport"`. See [URL references](overlays.md#url-references) |
| Bugs | `bugs` | array of `{ url = "..." }` tables | No | References to related issue-tracker entries; see [URL references](overlays.md#url-references) |

```toml
[component-groups.check-skip-initial-failures]
Expand All @@ -31,7 +31,7 @@ components = ["bats", "dnf", "git"]

[component-groups.check-skip-initial-failures.metadata]
category = "azl-disable-flaky-tests"
# upstreamable omitted: upstreamability for this group has not been assessed yet.
upstream-status = "upstreamable"
```

## Component Membership
Expand Down
15 changes: 7 additions & 8 deletions internal/projectconfig/loader_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -491,10 +491,10 @@ func TestLoadAndResolveProjectConfig_ComponentGroupWithMetadata(t *testing.T) {
specs = ["SPECS/**/*.spec"]

[component-groups.core.metadata]
category = "backport-dist-git"
commits = ["https://example.com/commit/abc"]
category = "upstream-backport"
commits = [{ url = "https://example.com/commit/abc" }]
bugs = [{ url = "https://example.com/bug/1" }]
upstreamable = true
upstream-status = "upstreamable"
`

ctx := testctx.NewCtx()
Expand All @@ -506,11 +506,10 @@ upstreamable = true
if assert.Contains(t, config.ComponentGroups, "core") {
group := config.ComponentGroups["core"]
require.NotNil(t, group.Metadata)
assert.Equal(t, OverlayCategoryBackportDistGit, group.Metadata.Category)
assert.Equal(t, []string{"https://example.com/commit/abc"}, group.Metadata.Commits)
assert.Equal(t, []BugRef{{URL: "https://example.com/bug/1"}}, group.Metadata.Bugs)
require.NotNil(t, group.Metadata.Upstreamable)
assert.True(t, *group.Metadata.Upstreamable)
assert.Equal(t, OverlayCategoryUpstreamBackport, group.Metadata.Category)
assert.Equal(t, []URLRef{{URL: "https://example.com/commit/abc"}}, group.Metadata.Commits)
assert.Equal(t, []URLRef{{URL: "https://example.com/bug/1"}}, group.Metadata.Bugs)
assert.Equal(t, OverlayUpstreamStatusUpstreamable, group.Metadata.UpstreamStatus)
}
}

Expand Down
Loading