Skip to content

Give the Function build an explicit examples root, and build it in CI - #21

Merged
mbakalarski merged 1 commit into
mainfrom
fix-function-examples-root
Jul 31, 2026
Merged

Give the Function build an explicit examples root, and build it in CI#21
mbakalarski merged 1 commit into
mainfrom
fix-function-examples-root

Conversation

@mbakalarski

Copy link
Copy Markdown
Member

What broke

The v0.1.4 release failed after the tag, on the Function package build:

failed to parse examples: examples/lab/topology.yaml:
Object 'Kind' is missing

That build passes no --examples-root, and the flag is not optional — it defaults to ./examples. So it collected examples/lab/topology.yaml, the helm values file added in #19, which has no kind. --ignore is no help: it does not reach --examples-root.

Why CI did not catch it

CI built the Configuration package, which names --examples-root=examples/fabric. The Function package build existed only in the release workflow — and with a different (defaulted) examples root. The two builds disagreed about what "the examples" are, and only the one that never ran on a PR saw the new file.

So this PR does two things:

  • names examples/fabric explicitly in the Function build, so both packages ship the same thing and say what it is — Fabric XRs, not lab scaffolding;
  • builds the Function package in CI, without embedding the runtime image, since that is irrelevant to whether package/ and the examples parse. Same principle as the existing runtime image job: do not let a failure be reachable only from the release.

Why v0.1.5 and not a retry of v0.1.4

configuration-avd:v0.1.4 was published before the function leg failed. Moving a tag that has already put an artifact on a registry is how one version number starts meaning two things.

v0.1.4 is not broken for consumers: configuration-avd depends on the function by range (>=v0.1.2), so it resolves to function-avd:v0.1.3. It is an incomplete release, not a failed one.

Both builds verified locally with the exact CI invocations.

🤖 Generated with Claude Code

The v0.1.4 release failed after the tag: the Function package build passes no
--examples-root, and that flag is not optional -- it defaults to ./examples. So
the build collected examples/lab/topology.yaml, helm values with no `kind`,
which had landed there in #19, and rejected it. --ignore would not have helped;
it does not reach --examples-root.

Naming examples/fabric explicitly makes both packages ship the same thing, and
says what that thing is: Fabric XRs. examples/lab is scaffolding for running a
lab, not a demonstration of the API.

CI could not have caught this. It built the Configuration package, which names
a narrower examples root, so the two builds disagreed about what "the examples"
are -- and the Function package's build existed only in the release, where a
failure costs a tag. It now runs on PRs too, without embedding the runtime
image, since that is irrelevant to whether the package and its examples parse.

Released as v0.1.5 rather than retrying v0.1.4: configuration-avd:v0.1.4 was
published before the function leg failed, and moving a tag that has already put
an artifact on a registry is how a version number starts meaning two things.
v0.1.4 is not broken for consumers -- configuration-avd depends on the function
by range, so it resolves to v0.1.3.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@mbakalarski
mbakalarski merged commit 37ec3a2 into main Jul 31, 2026
4 checks passed
@mbakalarski
mbakalarski deleted the fix-function-examples-root branch July 31, 2026 13:59
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.

1 participant