@kungfu-tech/buildchain 3.0.4-alpha.4 → 3.0.4-alpha.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (34) hide show
  1. package/AGENTS.md +14 -5
  2. package/README.md +18 -0
  3. package/bin/buildchain.mjs +10 -1
  4. package/dist/site/buildchain-contract.json +5 -5
  5. package/dist/site/buildchain-site.json +1459 -58
  6. package/dist/site/capability-registry.json +8 -5
  7. package/dist/site/cli-registry.json +1869 -0
  8. package/dist/site/kfd-claims.json +79 -7
  9. package/dist/site/kfd-upstream-aggregate.json +1 -1
  10. package/dist/site/manual-registry.json +47 -4
  11. package/dist/site/node-api-registry.json +17761 -6
  12. package/dist/site/page-registry.json +1435 -58
  13. package/dist/site/public-surface-audit.json +2809 -352
  14. package/dist/site/publication-registry.json +4 -4
  15. package/dist/site/site-manifest.json +32 -8
  16. package/docs/MAP.md +20 -5
  17. package/docs/cli-reference.md +1936 -0
  18. package/docs/cli.md +13 -0
  19. package/docs/getting-started.md +167 -0
  20. package/docs/node-api-reference.md +1949 -0
  21. package/docs/site-bundle-contract.md +10 -4
  22. package/docs/versioning.md +5 -4
  23. package/package.json +8 -5
  24. package/packages/core/buildchain-agent-manuals.js +37 -0
  25. package/packages/core/buildchain-kfd-claims.js +3 -36
  26. package/packages/core/paper-agent-entry.js +8 -4
  27. package/packages/core/paper.js +1 -0
  28. package/packages/core/publication-package.js +7 -0
  29. package/scripts/check-inventory.mjs +2 -2
  30. package/scripts/generate-public-reference.mjs +68 -0
  31. package/scripts/generate-site-bundle.mjs +19 -34
  32. package/scripts/public-reference.mjs +557 -0
  33. package/scripts/site-reference-registry.mjs +174 -0
  34. package/scripts/verify-golden-path.mjs +169 -0
@@ -1,8 +1,8 @@
1
1
  {
2
2
  "schemaVersion": 1,
3
3
  "contract": "kungfu-buildchain-publication-release-registry",
4
- "generatedAt": "2026-08-01T07:54:07.899Z",
5
- "publishedAt": "2026-08-01T07:54:07.899Z",
4
+ "generatedAt": "2026-08-01T11:04:27.961Z",
5
+ "publishedAt": "2026-08-01T11:04:27.961Z",
6
6
  "reproducible": true,
7
7
  "timestampPolicy": "ci-injected",
8
8
  "deterministicInputs": [
@@ -19,7 +19,7 @@
19
19
  "declared Buildchain surface manifest contract"
20
20
  ],
21
21
  "sourceDateEpoch": "0",
22
- "sourceRevision": "0395e290736c49c38982fc85d916d09ba07a5f16",
22
+ "sourceRevision": "ef33b573020c1866a3e22c260bdae2c1cacbc1d5",
23
23
  "timestampPolicyDetails": {
24
24
  "contract": "kungfu-buildchain-surface-timestamp-policy",
25
25
  "timestampFields": [
@@ -32,7 +32,7 @@
32
32
  },
33
33
  "package": {
34
34
  "name": "@kungfu-tech/buildchain",
35
- "version": "3.0.4-alpha.4",
35
+ "version": "3.0.4-alpha.6",
36
36
  "versionSource": "package.json#version"
37
37
  },
38
38
  "sourceKind": "package-site-bundle",
@@ -1,8 +1,8 @@
1
1
  {
2
2
  "schemaVersion": 1,
3
3
  "contract": "kungfu-buildchain-site-manifest",
4
- "generatedAt": "2026-08-01T07:54:07.899Z",
5
- "publishedAt": "2026-08-01T07:54:07.899Z",
4
+ "generatedAt": "2026-08-01T11:04:27.961Z",
5
+ "publishedAt": "2026-08-01T11:04:27.961Z",
6
6
  "reproducible": true,
7
7
  "timestampPolicy": "ci-injected",
8
8
  "deterministicInputs": [
@@ -19,7 +19,7 @@
19
19
  "declared Buildchain surface manifest contract"
20
20
  ],
21
21
  "sourceDateEpoch": "0",
22
- "sourceRevision": "0395e290736c49c38982fc85d916d09ba07a5f16",
22
+ "sourceRevision": "ef33b573020c1866a3e22c260bdae2c1cacbc1d5",
23
23
  "timestampPolicyDetails": {
24
24
  "contract": "kungfu-buildchain-surface-timestamp-policy",
25
25
  "timestampFields": [
@@ -37,7 +37,7 @@
37
37
  },
38
38
  "package": {
39
39
  "name": "@kungfu-tech/buildchain",
40
- "version": "3.0.4-alpha.4",
40
+ "version": "3.0.4-alpha.6",
41
41
  "versionSource": "package.json#version"
42
42
  },
43
43
  "entrypoint": "buildchain-site.json",
@@ -53,7 +53,15 @@
53
53
  "path": "docs/MAP.md",
54
54
  "plane": "use",
55
55
  "exists": true,
56
- "digest": "sha256:f6e378d0d583568b0ee90c8805b83b6f0a4faf0d1efa6e4a995482b5ecb8f538"
56
+ "digest": "sha256:0731b18f6a7aa6a164197080fac3b57ff161640a28433c4cd26adcf145403fb5"
57
+ },
58
+ {
59
+ "id": "getting-started",
60
+ "title": "Golden Path",
61
+ "path": "docs/getting-started.md",
62
+ "plane": "use",
63
+ "exists": true,
64
+ "digest": "sha256:806224481f542786ed2e60226417bd1ba673099a3110f564357792bdbf637403"
57
65
  },
58
66
  {
59
67
  "id": "auditable-demo",
@@ -181,7 +189,7 @@
181
189
  "path": "docs/site-bundle-contract.md",
182
190
  "plane": "use",
183
191
  "exists": true,
184
- "digest": "sha256:40831ce35dca6ac2a3a81d54a83fb0e5ab064137829a4f7844e5d80ba61aa65c"
192
+ "digest": "sha256:36a4e60e91f500ea1dcdbef97cd0250a2c26562b98d8d3622e8e0f9df2aad23b"
185
193
  },
186
194
  {
187
195
  "id": "migration-inventory",
@@ -213,7 +221,23 @@
213
221
  "path": "docs/cli.md",
214
222
  "plane": "use",
215
223
  "exists": true,
216
- "digest": "sha256:009640d0f4d5a670d8e5a73e4a14250d62c3cc0c3bd165aa84200e0098ef898e"
224
+ "digest": "sha256:0c8721e9c2f449e96aa8adefe99b016b193ab2876c02f3c61186794ac1873e90"
225
+ },
226
+ {
227
+ "id": "cli-reference",
228
+ "title": "Generated CLI reference",
229
+ "path": "docs/cli-reference.md",
230
+ "plane": "use",
231
+ "exists": true,
232
+ "digest": "sha256:c728fe693ab591ab5b52f4276a817ec5a013c79833f0d20ca2cc137e85ae51ca"
233
+ },
234
+ {
235
+ "id": "node-api-reference",
236
+ "title": "Generated Node API reference",
237
+ "path": "docs/node-api-reference.md",
238
+ "plane": "use",
239
+ "exists": true,
240
+ "digest": "sha256:2df82d2f754898d2f463ec0795e20f903f534dd537ac971e62b140beb21d49ee"
217
241
  },
218
242
  {
219
243
  "id": "build-facts",
@@ -293,7 +317,7 @@
293
317
  "path": "docs/versioning.md",
294
318
  "plane": "why",
295
319
  "exists": true,
296
- "digest": "sha256:5dd27f3c4a412a23093e5d33746a5d5d40353625c8ffe89a961978fc5de9c03e"
320
+ "digest": "sha256:bdb155e873f9c2ea5cd40bdde057d2c2f90322f0d4575de77fe1670bd040e643"
297
321
  },
298
322
  {
299
323
  "id": "web-surface-deployments",
package/docs/MAP.md CHANGED
@@ -30,6 +30,20 @@ running artifact), *use* (consume / extend) - and a **status**:
30
30
  - `to write` - planned; the material exists but is not yet a single doc.
31
31
  - `retired` - intentionally not part of the active Buildchain v3 surface.
32
32
 
33
+ ## Start by Role or Intent
34
+
35
+ | Role or intent | First entry | Then |
36
+ | --- | --- | --- |
37
+ | First-time repository adopter | [Golden Path](getting-started.md) | [Lifecycle Protocol](lifecycle-protocol.md) only when the generated defaults need changes |
38
+ | CLI operator or agent | [Generated CLI Reference](cli-reference.md) | [CLI guide](cli.md) for concepts and worked examples |
39
+ | Node toolkit developer | [Generated Node API Reference](node-api-reference.md) | [Core package guide](../packages/core/README.md) for recipes |
40
+ | Build/release operator | [Reusable Build Surface](reusable-build-surface.md) | [Release Flow](release-flow.md) and [Release Passport](release-passport.md) |
41
+ | Product/trust reviewer | [Product Mechanism](product-mechanism.md) | [Release Passport](release-passport.md) and [KFD Support](kfd-support.md) |
42
+
43
+ These entrypoints keep common destinations within three meaningful hops:
44
+ README or this map, the role entry, and the normative contract or generated
45
+ reference.
46
+
33
47
  ## Capability Coverage
34
48
 
35
49
  This package should be usable by an agent from the npm artifact alone. The
@@ -44,7 +58,7 @@ workflow, action, and Node API export also carries a `capabilityGroup`,
44
58
 
45
59
  | Capability group | Primary facts | Primary manuals |
46
60
  | --- | --- | --- |
47
- | Getting Started | `capability-registry.json`, `product-mechanism.json` | [`install.md`](install.md), [`product-mechanism.md`](product-mechanism.md), [`cli.md`](cli.md) |
61
+ | Getting Started | `capability-registry.json`, `product-mechanism.json` | [`getting-started.md`](getting-started.md), [`install.md`](install.md), [`product-mechanism.md`](product-mechanism.md), [`cli.md`](cli.md) |
48
62
  | Release Passport and Trust | `release-model.json`, `artifact-schemas.json`, `publication-authority-registry.json`, `kfd-claims.json` | [`release-passport.md`](release-passport.md), [`github-artifact-attestation.md`](github-artifact-attestation.md), [`publication-authority.md`](publication-authority.md), [`release-candidate.md`](release-candidate.md), [`publish-transaction.md`](publish-transaction.md), [`binary-distribution.md`](binary-distribution.md) |
49
63
  | Reusable Build and Lifecycle | `workflow-registry.json`, `controller-registry.json`, `release-model.json` | [`reusable-build-surface.md`](reusable-build-surface.md), [`controller-evidence.md`](controller-evidence.md), [`shifu-gate-profiles.md`](shifu-gate-profiles.md), [`lifecycle-protocol.md`](lifecycle-protocol.md) |
50
64
  | KFD Trust and Surface Closure | `kfd-claims.json`, `public-surface-audit.json`, `cli-registry.json`, `node-api-registry.json` | [`kfd-support.md`](kfd-support.md), [`release-passport.md`](release-passport.md) |
@@ -53,7 +67,7 @@ workflow, action, and Node API export also carries a `capabilityGroup`,
53
67
  | Distribution Indexes and Badges | `badge-endpoint-registry.json`, `node-api-registry.json`, `manual-registry.json` | [`readme-badges.md`](readme-badges.md), [`homebrew.md`](homebrew.md) |
54
68
  | Build Facts, Observability, and Diagnostics | `cli-registry.json`, `node-api-registry.json`, lifecycle artifacts | [`build-facts.md`](build-facts.md), [`toolkit-observability.md`](toolkit-observability.md), [`consumer-issue-reporting.md`](consumer-issue-reporting.md) |
55
69
  | Governance, Versioning, and Runtime Drift | `buildchain-contract.json`, `workflow-registry.json`, `release-model.json` | [`github-governance-authority.md`](github-governance-authority.md), [`release-governance.md`](release-governance.md), [`release-flow.md`](release-flow.md), [`versioning.md`](versioning.md), [`runtime-train-validation.md`](runtime-train-validation.md), [`cli.md`](cli.md) |
56
- | CLI and Node API Reference | `cli-registry.json`, `node-api-registry.json`, `workflow-registry.json`, `manual-registry.json` | [`cli.md`](cli.md), [`../packages/core/README.md`](../packages/core/README.md) |
70
+ | CLI and Node API Reference | `cli-registry.json`, `node-api-registry.json`, `workflow-registry.json`, `manual-registry.json` | [`cli-reference.md`](cli-reference.md), [`node-api-reference.md`](node-api-reference.md), [`cli.md`](cli.md), [`../packages/core/README.md`](../packages/core/README.md) |
57
71
 
58
72
  | Capability | Machine-readable entry | Manual entry |
59
73
  | --- | --- | --- |
@@ -87,12 +101,13 @@ replace them.
87
101
  | Your question | Document | Plane | Status |
88
102
  | --- | --- | --- | --- |
89
103
  | What is Buildchain, in one idea? | [`../README.md`](../README.md) | - | stable |
104
+ | How do I complete a first clean adoption in 15–30 minutes? | [`getting-started.md`](getting-started.md) | use | stable |
90
105
  | Why is Buildchain a Release Passport mechanism rather than a generic workflow collection? | [`product-mechanism.md`](product-mechanism.md) | why | stable |
91
106
  | How do agents and contributors enter this repo? | [`../AGENTS.md`](../AGENTS.md) + [`../CONTRIBUTING.md`](../CONTRIBUTING.md) | use | stable |
92
107
  | How do I install a standalone binary or npm package? | [`install.md`](install.md) | use | stable |
93
- | How do I run the `buildchain` CLI? | [`cli.md`](cli.md) | use | stable |
94
- | How do I import Buildchain toolkit APIs from JavaScript build code? | [`toolkit-observability.md`](toolkit-observability.md) + [`../packages/core/README.md`](../packages/core/README.md) | use | stable |
95
- | How do I initialize a new repository? | [`cli.md`](cli.md) + [`lifecycle-protocol.md`](lifecycle-protocol.md) | use | stable |
108
+ | How do I run or look up the `buildchain` CLI? | [`cli-reference.md`](cli-reference.md) + [`cli.md`](cli.md) | use | stable |
109
+ | How do I import Buildchain toolkit APIs from JavaScript build code? | [`node-api-reference.md`](node-api-reference.md) + [`../packages/core/README.md`](../packages/core/README.md) | use | stable |
110
+ | How do I initialize a new repository? | [`getting-started.md`](getting-started.md) + [`lifecycle-protocol.md`](lifecycle-protocol.md) | use | stable |
96
111
  | Why does Buildchain use branch-driven release governance? | [`release-governance.md`](release-governance.md) | why | stable |
97
112
  | How do protected dev branches and scheduled ready-PR merging work? | [`release-governance.md`](release-governance.md#protected-dev-branches) | use | stable |
98
113
  | How do slow required checks land reliably on a busy dev channel? | [`release-governance.md`](release-governance.md#protected-dev-branches) + [`cli.md`](cli.md#commands) | use | preview |