docs: add buildstream skill for factory-wide BST patterns - #979
Draft
castrojo wants to merge 2 commits into
Draft
Conversation
Capture the BuildStream 2 patterns that are true for every factory BST repo (dakota and fsdk-containers) as a new docs/skills/buildstream/ skill: graph-first debugging, element-kind and dependency-type semantics, cache-key invalidation cones, upstream-first junction hygiene, and source/ref discipline. Per-repo product decisions (platform.bst vs components/* composition, x86_64_v3, distroless SLIM recipe) are explicitly documented as NOT factory-general, with pointers to each repo's own skills. BST behavior claims verified against /apache/buildstream docs (arch_cachekeys.md, format_public.md, format_project.md, handling-files/composition.md). Registers the skill in docs/SKILL.md, regenerates the skill index, and adds /apache/buildstream to the known Context7 library IDs in context7.md. Assisted-by: Claude via GitHub Copilot Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
The first draft repeated dakota patch-junctions.md's absolute "no local
junction patch queues" rule. That rule is false in practice: dakota
carries 7 patches in patches/freedesktop-sdk/ and fsdk-containers
carries 0001+0002, both deliberately replicating the parent project's
queue so cache keys align with the parent's published artifact cache.
Restate the principle as drift control: a junction's patch_queue is
part of its source hash, so patches diverging from the parent's queue
are cache-destroying (prohibited) while patches replicating it
byte-for-byte are cache-aligning (mandatory). The per-repo parameter is
which upstream project's queue to match; dakota enforces it with
just patch-drift-check in CI.
Evidence: dakota/patches/freedesktop-sdk/ (7 patches, incl. patch_queue
in elements/freedesktop-sdk.bst), fsdk-containers
elements/{freedesktop-sdk,gnome-build-meta}.bst, dakota
docs/skills/bst-overrides.md.
Assisted-by: Claude via GitHub Copilot
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Adds
docs/skills/buildstream/— a factory-level skill capturing the BuildStream 2 patterns that are true for every factory BST repo (today:dakotaandfsdk-containers), harvested from both repos'docs/skills/.SKILL.md— scope rule, the per-repo divergence table, 7 core patterns, red flags, verificationreferences/cache-keys-and-junctions.md— strong/weak key model, invalidation cones, junction drift-control policyreferences/element-authoring.md— element/source kinds, dependency types, variables, conditionals, sandbox constraints, overlap rulesdocs/SKILL.mdrouter;index.json/index.mdregenerated;/apache/buildstreamadded to the known Context7 IDs incontext7.mdJunction patch queues: drift control, not "never patch"
A junction's
patch_queueis part of its source hash, so the queue determines which upstream artifact cache your keys align with:just patch-drift-checkin CI); the per-repo parameter is which upstream queue to match (currentlygnome-build-metaat the pinned ref in both repos).Note: dakota's own
docs/skills/patch-junctions.mdstates an absolute "NO LOCAL JUNCTION PATCH QUEUES" rule that is contradicted by dakota's current state (patches/freedesktop-sdk/carries 0001–0007) and by its ownbst-overrides.md(byte-identity requirement). That inconsistency is reported for correction at the source in dakota — this skill deliberately does NOT repeat the absolute rule.The general-vs-repo-specific line
Promoted only what holds in both repos. Explicitly documented as per-repo decisions, not factory rules:
components/*only,platform.bstbannedx86_64_v3just verifyNot promoted: dakota's packaging templates (
packaging-*.md), systemd/preset/dconf/bootc-ldconfig rules, GNOME/GL specifics; fsdk-containers' SLIM recipe, no-shell rule, verify gates, FSDK-tag versioning.Evidence
/apache/buildstream(arch_cachekeys.md,format_public.md,format_project.md,handling-files/composition.md,downloadablefilesource.py); cited inline.project.confoptions in both repos, fsdkintegration/ldconfig.bstusage, dakotaelements/freedesktop-sdk.bstv3 conditional, both repos' junction patch queues.pre-commit run --all-filesgreen (front-matter, index staleness, doc links).Docs-only change (
docs/**); opened as draft for review per factory PR policy.