Product mechanism facts
A mature product release record for artifacts that users or agents depend on.
Back to Buildchain homemechanism / complete reference
Inspect the complete KFD-2/3 trust model, Hub boundary, package-owned mechanism, CLI, workflows, artifacts, and release facts.
01 · Guided synthesis · site-owned
A Hub can accept more capability without inheriting blind trust. Buildchain turns a Builder's public offer and its supporting facts into one release-bound surface that the Hub can evaluate under its own policy.
Sourcesbuildchain-release-passportbuildchain-kfd-supportkfd-2kfd-3kfd-agent-hub-profile02 · KFD-2 × KFD-3
Discovery alone leaves a Hub with marketing claims. Evidence alone leaves useful capability hidden in private release machinery. The two become an adoption surface only when the offer and its trust boundary travel together.
Sourcesbuildchain-release-passportbuildchain-kfd-supportkfd-2kfd-3Declare the offer
The Builder exposes what the product can do, why it is useful, which public surfaces carry it, and which choices and constraints apply.
Sourceskfd-3buildchain-kfd-supportAssess reliance
Each important value claim binds to inspectable facts, checked evidence, assurance responsibility, known gaps, and residual risk.
Sourceskfd-2buildchain-kfd-supportBind the exact release
The Release Passport keeps the claim congruent with exact source, artifacts, verification, provenance, and promotion evidence.
Sourcesbuildchain-release-passportbuildchain-kfd-supportKeep the verdict local
The receiving Hub evaluates that exact release under its own identity, authority, policy, and risk boundary; discovery or delivery never forces admission.
Sourceskfd-agent-hub-profilekfd-203 · Builder Hub value
Buildchain lowers the marginal cost of extending a Hub without turning a third-party integration into an invisible transfer of trust or product control.
Sourcesbuildchain-release-passportbuildchain-kfd-supportkfd-2kfd-3kfd-agent-hub-profileExpand the capability supply while keeping important reliance claims inspectable and bounded.
Sourceskfd-2kfd-3Evaluate a declared capability and its evidence instead of reconstructing a bespoke trust story for every integration.
Sourcesbuildchain-kfd-supportkfd-2kfd-3Treat an update as a new exact release and evidence coordinate that can be reassessed, explained, or rolled back.
Sourcesbuildchain-release-passportkfd-2Share the trust substrate while differentiating through models, policy, user experience, distribution, and the customer relationship.
Sourceskfd-agent-hub-profilekfd-304 · Ecosystem effect · future picture
When Builders publish the same release-bound capability and trust facts that Hubs can evaluate locally, one integration can become reusable supply instead of a one-off bilateral trust exercise.
Sourcesbuildchain-release-passportbuildchain-kfd-supportkfd-2kfd-3kfd-agent-hub-profileA Builder declares public capability surfaces and their evidence against one exact artifact coordinate.
Sourcesbuildchain-release-passportbuildchain-kfd-supportEach Hub keeps its own acceptance verdict; compatibility never transfers approval, authority, or responsibility.
Sourceskfd-agent-hub-profilekfd-2More release-bound offers can lower the marginal cost of publishing and admitting capabilities across independently owned Hubs.
Sourceskfd-3kfd-agent-hub-profileClaim boundary: This is the ecosystem effect enabled by the contract, not evidence of a present network effect. The KFD Agent Hub profile is alpha and does not prove external adoption, plural-Hub deployment, stable certification, or an industry standard. Sourceskfd-agent-hub-profile
05 · Product boundary
Buildchain is a public release-trust layer below the Hub product. It does not become the Hub, a marketplace, a global identity provider, a mandatory cloud, or a channel into the Builder's customer relationship.
Sourcesbuildchain-release-passportkfd-agent-hub-profile06 · Upstream authority · @kungfu-tech/buildchain
Buildchain Release Passport is a mature product release record for artifacts that users or agents depend on.
Buildchain by Kungfu uses GitHub as the execution and trust substrate: protected refs, reviewed promotion PRs, exact tags, GitHub Releases, npm Trusted Publishing, and machine-readable evidence. Its job is to turn release intent into an auditable product record, not to ask a repository to migrate away from its existing CI.
The same mechanism releases Buildchain itself.
primary
For v3, use the published npm package and verify the release passport before trusting release evidence:
curl -LO https://github.com/kungfu-systems/buildchain/releases/download/v3.0.0/buildchain.release.json
curl -LO https://github.com/kungfu-systems/buildchain/releases/download/v3.0.0/artifact-evidence.json
npx @kungfu-tech/buildchain@3.0.0 verify release-passport buildchain.release.json
npx @kungfu-tech/buildchain@3.0.0 version
The v3.0.0 release publishes evidence assets but no standalone platform archives. The names below describe the optional archive contract used by legacy release lines:
buildchain-x86_64-unknown-linux-gnu.tar.gzbuildchain-aarch64-apple-darwin.tar.gzbuildchain-x86_64-pc-windows-msvc.zipchecksums.txtbuildchain.release.jsonartifact-evidence.jsonproduct-mechanism.jsonimpact.jsonagent-index.jsoncheck-report.jsonllms.txtbuildchain-release-bundle.tar.gzbuildchain-release-bundle.jsonLoose top-level buildchain and buildchain.exe assets are intentionally not
published. The executable lives inside each platform archive, which prevents
Linux and macOS artifacts from overwriting each other in a merged release lane.
For npm consumers:
npm install -D @kungfu-tech/buildchain
npx buildchain version
npx buildchain doctor --json
The npm package is also the Buildchain toolkit. Use the command when a workflow or shell step needs an executable; use the ESM APIs directly from JavaScript build scripts. JavaScript callers should import the package instead of spawning the CLI or unpacking the standalone binary:
import {
createBuildchainLogger,
verifyBuildchainLogEvents,
} from "@kungfu-tech/buildchain/logging";
const logger = createBuildchainLogger({
path: ".buildchain/logs/native-build.jsonl",
source: "user",
component: "native-build",
});
await logger.span("native.compile", { phase: "build" }, async () => {
await compileNativeTargets();
});
const report = verifyBuildchainLogEvents({
path: logger.path,
requireEvents: ["native.compile.start", "native.compile.end"],
});
The package also ships dist/site/ as the Buildchain-owned fact source for
buildchain.libkungfu.dev.
Repositories can also generate README status badges from Buildchain-owned facts instead of hand-maintaining badge Markdown:
buildchain badges bundle --check
buildchain badges bundle --write
buildchain badges readme --check
buildchain badges readme --write
primary
Bootstrap a repository:
npx @kungfu-tech/buildchain init --type package --package-manager pnpm
npx @kungfu-tech/buildchain validate --require-version-state
npx @kungfu-tech/buildchain release --dry-run --target-ref alpha/v3/v3.0
Buildchain supports package and non-package projects through
.buildchain/buildchain.toml. Legacy root buildchain.toml files remain
readable, but new consumers should keep Buildchain-owned files under
.buildchain/:
.buildchain/buildchain.toml
.buildchain/contract-lock.json
.buildchain/kfd/kfd-3/surfaces.json
.buildchain/release-passport/buildchain.release.json
Lifecycle commands can call pnpm, npm, yarn, pip, Conan, CMake, Make, custom scripts, or any other command that can run in the repository checkout.
The KFD entrypoint is buildchain kfd. Buildchain provides concrete KFD-1
contract-world, KFD-2 trust-claim, and KFD-3 collaboration-surface workflows,
plus fail-closed product-evidence gates for KFD-4, KFD-5, and KFD-7. These
gates preserve product-owned qualification and support decisions; they do not
turn a schema-valid record into certification or shipped support.
Buildchain’s active GitHub Action surface is deliberately small:
actions/validate-configactions/run-lifecycleactions/promote-buildchain-refactions/report-buildchain-issueThe active reusable workflow surfaces are:
.github/workflows/.gate-profile.yml for project-neutral Shifu Gate profile
planning, capability-aware runner dispatch, receipt validation, and one
stable aggregate check;.github/workflows/.auditable-demo.yml for exact-artifact demo
qualification, transcript-bound renderer smoke, and optional media rendering
from the exact passing Gate bundle;.github/workflows/.build.yml for deterministic multi-platform build and
artifact contracts;.github/workflows/build.yml for the single-config channel router that uses
vN-alpha during development/prerelease work and vN for stable releases;.github/workflows/release-candidate-promote.yml for post-merge
promote-only publication from a PR-stage release candidate, without a second
heavy build;.github/workflows/.web-surface.yml for preview, staging, production, and
cleanup plans for site/app repositories;.github/workflows/buildchain-ref-promotion.yml for protected release
promotion and version-state transactions;.github/workflows/binary-distribution.yml for Buildchain’s own release
passport proof case.Stable consumers should reference actions and workflows through floating major refs after reviewing the exact release passport:
uses: kungfu-systems/buildchain/actions/validate-config@v3
uses: kungfu-systems/buildchain/.github/workflows/build.yml@v3
uses: kungfu-systems/buildchain/.github/workflows/release-candidate-promote.yml@v3
primary
Buildchain treats a reviewed branch merge as release intent:
| Merge path | Meaning | Exact tag | Floating refs |
|---|---|---|---|
dev/vX/vX.Y -> alpha/vX/vX.Y |
publish the next testable alpha for a minor line | vX.Y.Z-alpha.N |
vX.Y-alpha, alpha/vX/vX.Y, dev/vX/vX.Y |
alpha/vX/vX.Y -> release/vX/vX.Y |
publish production for that minor line | vX.Y.Z |
vX.Y, usually vX, release/vX/vX.Y |
release/vX/vX.Y -> publish-gate/major |
publish the next major from a reviewed production line | v(X+1).0.0 |
v(X+1), v(X+1).0, new dev/alpha/release branches |
Exact tags are immutable. Floating channel tags and branches are machine-updated by Buildchain and must remain writable by the release authority.
After a production release, Buildchain prepares the next alpha source commit for the same minor line. That keeps production consumers pinned to the production passport while development can continue on the next testable patch.
publish-gate/major is not an active development trunk. It is a reviewed
promotion gate used when maintainers decide that the next production release
should open a new major line.
support
Buildchain includes a logging toolkit for release and build steps. Inside JavaScript build code, prefer the package API:
import { createBuildchainLogger } from "@kungfu-tech/buildchain/logging";
const logger = createBuildchainLogger({ source: "user", component: "conan" });
logger.mark("conan.profile.ready", { phase: "configure" });
await logger.span("conan.install", { phase: "dependencies" }, runConanInstall);
In workflows or shell scripts, use the equivalent CLI:
buildchain mark --event native.configure --phase configure --component cmake
buildchain span --event native.build --phase build -- cmake --build build
buildchain log summary --json
buildchain verify observability-log .buildchain/logs/events.jsonl --min-events 4
Every event records a timestamp. span records duration. The API form can be
imported from repository scripts so heavy builds can mark phases from inside
their own code.
support
@kungfu-tech/buildchain publishes dist/site/:
buildchain-site.jsonsite-manifest.jsonpage-registry.jsoncli-registry.jsonworkflow-registry.jsonrelease-model.jsonartifact-schemas.jsonproduct-mechanism.jsonrelease-provenance.jsonagent-index.jsonbuildchain.libkungfu.dev should render from these package-owned facts, then
layer presentation around them. The site should not hand-write Buildchain’s
current release mechanics. page-registry.json is the complete markdown page
source for the public site: README homepage content, all packaged docs/*.md
manuals, action READMEs, the Node API package overview, and fixture guides.
A mature product release record for artifacts that users or agents depend on.
Inspect read-only publication authority audit commands.
Inspect README badge command families.
Generate or verify the combined KFD and Release Passport badge bundle.
Generate or verify managed README badge blocks.
Resolve Buildchain runtime contract metadata for floating-ref drift checks.
Collect and verify Git source, version, module output, product artifact, and legacy Kungfu buildinfo facts.
Inspect source-bound candidate evidence command families.
Inspect release evidence collection command families.
Collect GitHub Release assets into a release passport.
Create canonical sealed publication evidence documents.
Inspect protected development-channel governance command families.
Inspect diagnostics command families.
Summarize diagnostics artifacts into JSON and cross-platform lifecycle timing tables.
Report local integration readiness.
Inspect release and artifact explanation command families.
Explain artifact evidence for humans or agents.
Explain a release passport for humans or agents.
Inspect build facts command families.
Plan, apply, or roll back one root-bound GitHub branch-protection rollout after a frozen read-only inventory.
Print Buildchain CLI help.
Inspect Homebrew distribution-index command families.
Verify Homebrew tap metadata against upstream release passport evidence.
Generate Homebrew Formula metadata from upstream release passport evidence.
Validate and publish provider-neutral infrastructure contract evidence.
Bootstrap a repository with Buildchain configuration and caller workflow files.
Inspect release and artifact evidence command families.
Inspect artifact evidence.
Inspect release passport evidence.
Inspect KFD standards, schemas, and versioned KFD command families.
Generate KFD-1 release gate evidence from declared contract-world witnesses.
Print the default KFD-1 schema exposed by the KFD package standards metadata.
Validate KFD-1 release gate evidence.
Generate Buildchain's KFD-1 self contract-world witness.
Generate Buildchain's KFD-2 public trust claim evidence.
Validate and render product-owned KFD-2 claims in the canonical .buildchain/kfd layout.
Print the default KFD-2 schema exposed by the KFD package standards metadata.
Validate KFD-2 trust taxonomy entries from the KFD package standards metadata.
Expose and validate the KFD package foundation KFD-2 trust assessment.
Expose and validate the KFD package foundation KFD-2 trust claims.
Inspect KFD-3 surface detection, registry, witness, audit, and query command families under the unified KFD namespace.
Compare detected, declared, and enforced KFD-3 public surfaces.
Detect standard KFD-3 public surface candidates from source and artifact metadata.
Return an agent-readable KFD-3 capability map for a product, registry, or release passport.
Declare detected KFD-3 public surfaces into a product-owned surface registry.
Generate release-passport-compatible KFD-3 surface witnesses from a product registry.
Evaluate source-bound KFD-4 observer-perspective and contrastive-replay product evidence.
Print the default KFD-4 schema exposed by the KFD package standards metadata.
Verify a retained KFD-4 product-gate result without widening product support.
Evaluate source-bound KFD-5 Primitive discovery qualification evidence.
Print the default KFD-5 schema exposed by the KFD package standards metadata.
Verify a retained KFD-5 product-gate result without widening product support.
Evaluate a source-bound KFD-7 Domain Profile, evidence obligations, and independent review.
Print the default KFD-7 schema exposed by the KFD package standards metadata.
Verify a retained KFD-7 product-gate result without widening product support.
Return a product KFD view that combines own KFD status with upstream KFD aggregate facts.
Initialize, inspect, test, and explain one declarative KFD Agent Hub adapter adoption.
Plan or apply migration of legacy root Buildchain files into .buildchain/.
List machine-readable schemas exposed by the KFD package standards metadata.
Print a machine-readable KFD schema from the KFD package standards metadata.
Report implemented KFD support and the active .buildchain repository layout.
Project and verify a product-owned KFD-1 through KFD-13 support matrix against KFD-4/5/7 gates.
Validate a KFD upstream aggregate document and fail closed on missing evidence.
Collect declared KFD-aware upstream package evidence and hashes from Buildchain config.
List Buildchain-managed KFD upstream role values and inference policy.
Return the versioned repository-layout and KFD registry discovery contract for tools such as Shifu.
Run configured lifecycle commands and write deterministic artifact manifests.
Inspect Buildchain logging command families.
Emit timestamped build events, summarize logs, and enforce required phases.
Emit a single Buildchain log event.
Inspect npm publishing command families.
Verify npm publish shape before a release transaction.
Plan exact portable dependency/compiler cache inputs and seal provider outcomes.
Inspect read-only consumer projection command families.
Generate publication artifact manifests, passports, and source bundles for paper/report repositories.
Write a site-consumable publication artifact manifest, publication passport, and source bundle.
Synthesize the declared npm paper package from a publication artifact manifest, passport, registry, source bundle, and primary artifact.
Create, inspect, or verify publish-gate source-lock refs.
Explain what a channel merge would publish before the PR is merged.
Reconcile a managed branch's Buildchain aggregate check to an already-tested pull request SHA.
Plan or write the initial version-state commit for a new minor release line.
Plan channel-preserving downstream release PRs and write exact upstream release locks.
Inspect, recover, finalize, or abort durable release transactions.
Inspect sampler command families.
Sample process-tree diagnostics for a wrapped command.
Run a command inside a Buildchain log span.
Inspect durable release transaction state.
Validate .buildchain/buildchain.toml and declared lifecycle surfaces.
Inspect release and artifact verification command families.
Verify artifact subjects against release passport evidence.
Verify exact roots, identity, lifecycle, revocation, and an existing KFD assessment in a sealed artifact envelope.
Fail closed unless an infra-contract lifecycle evidence bundle is complete, hash-bound, and validation-consistent.
Verify Buildchain observability log events.
Independently verify sealed publication admission, runner provenance, control-plane audit, nonce freshness, and exact artifact bindings.
Fail closed unless a release passport and its evidence are complete.
Print the package or embedded binary version.
Plan, verify, and apply Buildchain web-surface deployments.
.github/workflows/.auditable-demo.yml
.github/workflows/.binary-release-assets.yml
.github/workflows/.build.yml
.github/workflows/.bump-minor-version.yml
.github/workflows/.gate-profile.yml
.github/workflows/.publication-authority.yml
.github/workflows/.release-candidate-promote.yml
.github/workflows/.release-docker.yml
.github/workflows/.release-elastic-beanstalk.yml
.github/workflows/.release-new-version.yml
.github/workflows/.release-verify.yml
.github/workflows/.sam-release.yml
.github/workflows/.sam-verify.yml
.github/workflows/.sync-release-page.yml
.github/workflows/.sync-remote-git.yml
.github/workflows/.web-surface.yml
.github/workflows/.wheel-release.yml
.github/workflows/.wheel-verify.yml
.github/workflows/binary-distribution.yml
.github/workflows/binary-release-assets.yml
.github/workflows/build-surface-fixture.yml
.github/workflows/build.yml
.github/workflows/buildchain-alpha-self-dogfood.yml
.github/workflows/buildchain-patrol-daily.yml
.github/workflows/buildchain-patrol-monthly.yml
.github/workflows/buildchain-patrol-weekly.yml
.github/workflows/buildchain-patrol.yml
.github/workflows/buildchain-ref-promotion.yml
.github/workflows/buildchain-stable-candidate-patrol.yml
.github/workflows/buildchain-stable-candidate-qualification.yml
.github/workflows/candidate-lab.yml
.github/workflows/check.yml
.github/workflows/dev-merge-queue-governance.yml
.github/workflows/dev-pr-auto-merge.yml
.github/workflows/github-governance-audit.yml
.github/workflows/npm-publish.yml
.github/workflows/paper-release-sealed.yml
.github/workflows/paper-release.yml
.github/workflows/patrol-daily.yml
.github/workflows/patrol-monthly.yml
.github/workflows/patrol-observed-evidence.yml
.github/workflows/patrol-weekly.yml
.github/workflows/publication-artifact.yml
.github/workflows/release-candidate-promote.yml
.github/workflows/release-governance-reconcile.yml
.github/workflows/release-line-bootstrap.yml
.github/workflows/release-new-version.yml
.github/workflows/release-propagation.yml
.github/workflows/release-verify.yml
.github/workflows/schedule-purge-artifacts.yml
.github/workflows/self-hosted-runner-smoke.yml
.github/workflows/stable-candidate-patrol.yml
.github/workflows/verify.yml
actions/macos-credential-island/action.yml
actions/promote-buildchain-ref/action.yml
actions/report-buildchain-issue/action.yml
actions/run-lifecycle/action.yml
actions/validate-config/action.yml
page-registry.jsoncapability-registry.jsoncli-registry.jsonmanual-registry.jsonnode-api-registry.jsonworkflow-registry.jsoncontroller-registry.jsonpublication-authority-registry.jsonpublic-surface-audit.jsonrelease-model.jsonartifact-schemas.jsonbadge-endpoint-registry.jsonpublication-registry.jsonproduct-mechanism.jsonrelease-provenance.jsonkfd-upstream-aggregate.jsonkfd-claims.jsonagent-index.jsonsite-manifest.jsonrelease-passport-check-manifest.jsonschemas/release-passport-v1.schema.jsonschemas/kfd-agent-hub-adoption.schema.jsonschemas/kfd-product-gate-input-v1.schema.jsonschemas/kfd-support-projection-v1.schema.jsonbuildchain-contract.jsonbuildchain.release.jsonbuildchain-release-bundle.tar.gzkungfu-buildchain-artifact-schema-indexkungfu-buildchain-release-provenance