artifact-chain-assistant 0.8.4 → 0.9.0
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.
- package/.claude-plugin/plugin.json +3 -3
- package/.codex-plugin/plugin.json +2 -2
- package/.kimi-plugin/plugin.json +19 -0
- package/CHANGELOG.md +35 -0
- package/INSTALL.md +36 -12
- package/README.md +17 -6
- package/README.zh-CN.md +17 -6
- package/adapters/claude/.claude-plugin/plugin.json +3 -3
- package/adapters/claude/INSTALL.md +36 -12
- package/adapters/claude/agent-methods/catalog.yaml +1 -1
- package/adapters/claude/compatibility.json +4 -4
- package/adapters/claude/family-apis/catalog.json +1 -1
- package/adapters/claude/scripts/lib/compatibility-policy.mjs +7 -4
- package/adapters/codex/.codex-plugin/plugin.json +2 -2
- package/adapters/codex/INSTALL.md +36 -12
- package/adapters/codex/agent-methods/catalog.yaml +1 -1
- package/adapters/codex/compatibility.json +4 -4
- package/adapters/codex/family-apis/catalog.json +1 -1
- package/adapters/codex/scripts/lib/compatibility-policy.mjs +7 -4
- package/adapters/kimi/.kimi-plugin/plugin.json +19 -0
- package/adapters/kimi/EXTENDED-ARTIFACT-CATALOG.md +315 -0
- package/adapters/kimi/EXTENDED-ARTIFACT-CATALOG.zh-CN.md +292 -0
- package/adapters/kimi/INSTALL.md +1381 -0
- package/adapters/kimi/agent-methods/catalog.yaml +296 -0
- package/adapters/kimi/compatibility.json +9 -0
- package/adapters/kimi/families-src/prd-feature/implementation.yaml +39 -0
- package/adapters/kimi/families-src/scenario-script/implementation.yaml +39 -0
- package/adapters/kimi/family-apis/catalog.json +16 -0
- package/adapters/kimi/family-apis/e2e-test/api.json +205 -0
- package/adapters/kimi/family-apis/schema/family-api.schema.json +235 -0
- package/adapters/kimi/schemas/artifact-workflow-profile.schema.json +72 -0
- package/adapters/kimi/schemas/project-facts.schema.json +80 -0
- package/adapters/kimi/scripts/batch-merge.mjs +276 -0
- package/adapters/kimi/scripts/batch-split.mjs +184 -0
- package/adapters/kimi/scripts/check-family-api.mjs +84 -0
- package/adapters/kimi/scripts/check-workflow-profile.mjs +64 -0
- package/adapters/kimi/scripts/doctor.mjs +44 -0
- package/adapters/kimi/scripts/export-family-api.mjs +184 -0
- package/adapters/kimi/scripts/family-compile.mjs +309 -0
- package/adapters/kimi/scripts/family-help-render.mjs +214 -0
- package/adapters/kimi/scripts/lib/artifact-graph-runtime.mjs +189 -0
- package/adapters/kimi/scripts/lib/compatibility-policy.mjs +373 -0
- package/adapters/kimi/scripts/lib/family-api-validator.mjs +413 -0
- package/adapters/kimi/scripts/lib/generated/canonical-json-v1-manifest.json +7 -0
- package/adapters/kimi/scripts/lib/generated/canonical-json-v1-vectors.generated.json +50 -0
- package/adapters/kimi/scripts/lib/generated/canonical-json-v1.generated.mjs +130 -0
- package/adapters/kimi/scripts/lib/generated/family-api-validator.generated.mjs +1756 -0
- package/adapters/kimi/scripts/lib/generated/project-facts-validator.generated.mjs +638 -0
- package/adapters/kimi/scripts/lib/generated/schema-validator-manifest.json +20 -0
- package/adapters/kimi/scripts/lib/inline-yaml-parser.mjs +216 -0
- package/adapters/kimi/scripts/lib/method-query.mjs +177 -0
- package/adapters/kimi/scripts/lib/method-registry-version.mjs +7 -0
- package/adapters/kimi/scripts/lib/workflow-profile.mjs +645 -0
- package/adapters/kimi/scripts/method-query.mjs +67 -0
- package/adapters/kimi/scripts/run-artifact-workflow.mjs +366 -0
- package/adapters/kimi/skills/artifact-audit/SKILL.md +80 -0
- package/adapters/kimi/skills/artifact-batch/SKILL.md +115 -0
- package/adapters/kimi/skills/artifact-chain-bootstrap/SKILL.md +343 -0
- package/adapters/kimi/skills/artifact-chain-maintainer/SKILL.md +167 -0
- package/adapters/kimi/skills/artifact-generate/SKILL.md +89 -0
- package/adapters/kimi/skills/artifact-repair/SKILL.md +124 -0
- package/adapters/kimi/skills/artifact-review/SKILL.md +122 -0
- package/adapters/kimi/skills/artifact-workflow-worker/SKILL.md +90 -0
- package/adapters/kimi/skills/help/SKILL.md +96 -0
- package/adapters/kimi/skills/prd-feature/SKILL.md +68 -0
- package/adapters/kimi/skills/prd-feature/author/SKILL.md +92 -0
- package/adapters/kimi/skills/prd-feature/author/references/compose.md +43 -0
- package/adapters/kimi/skills/prd-feature/author/references/inspect.md +94 -0
- package/adapters/kimi/skills/prd-feature/author/references/validate.md +65 -0
- package/adapters/kimi/skills/prd-feature/references/compose.md +43 -0
- package/adapters/kimi/skills/prd-feature/references/inspect.md +94 -0
- package/adapters/kimi/skills/prd-feature/references/validate.md +65 -0
- package/adapters/kimi/skills/prd-feature/repair/SKILL.md +135 -0
- package/adapters/kimi/skills/prd-feature/review/SKILL.md +134 -0
- package/adapters/kimi/skills/prd-feature/review/references/compose.md +43 -0
- package/adapters/kimi/skills/prd-feature/review/references/inspect.md +94 -0
- package/adapters/kimi/skills/prd-feature/review/references/validate.md +65 -0
- package/adapters/kimi/skills/quickstart/SKILL.md +113 -0
- package/adapters/kimi/skills/scenario-script/SKILL.md +76 -0
- package/adapters/kimi/skills/scenario-script/author/SKILL.md +111 -0
- package/adapters/kimi/skills/scenario-script/author/references/compose.md +43 -0
- package/adapters/kimi/skills/scenario-script/author/references/inspect.md +105 -0
- package/adapters/kimi/skills/scenario-script/author/references/validate.md +72 -0
- package/adapters/kimi/skills/scenario-script/references/compose.md +43 -0
- package/adapters/kimi/skills/scenario-script/references/inspect.md +105 -0
- package/adapters/kimi/skills/scenario-script/references/validate.md +72 -0
- package/adapters/kimi/skills/scenario-script/repair/SKILL.md +135 -0
- package/adapters/kimi/skills/scenario-script/review/SKILL.md +137 -0
- package/adapters/kimi/skills/scenario-script/review/references/compose.md +43 -0
- package/adapters/kimi/skills/scenario-script/review/references/inspect.md +105 -0
- package/adapters/kimi/skills/scenario-script/review/references/validate.md +72 -0
- package/adapters/kimi/skills/setup/SKILL.md +119 -0
- package/adapters/kimi/skills/where-am-i/SKILL.md +233 -0
- package/adapters/kimi/templates/README.md +159 -0
- package/adapters/kimi/templates/core/decision/review-checklist.md +35 -0
- package/adapters/kimi/templates/core/decision/starter.md +66 -0
- package/adapters/kimi/templates/core/design/review-checklist.md +41 -0
- package/adapters/kimi/templates/core/design/starter.md +84 -0
- package/adapters/kimi/templates/core/e2e_test/review-checklist.md +43 -0
- package/adapters/kimi/templates/core/e2e_test/starter.md +70 -0
- package/adapters/kimi/templates/core/feature/review-checklist.md +29 -0
- package/adapters/kimi/templates/core/feature/starter.md +43 -0
- package/adapters/kimi/templates/core/scenario/review-checklist.md +29 -0
- package/adapters/kimi/templates/core/scenario/starter.md +57 -0
- package/adapters/kimi/templates/core/test/review-checklist.md +37 -0
- package/adapters/kimi/templates/core/test/starter.md +70 -0
- package/adapters/kimi/templates/extended/ADOPTION-GUIDE.md +263 -0
- package/adapters/kimi/templates/extended/README.md +261 -0
- package/adapters/kimi/templates/extended/agent/agent_skill/review-checklist.md +51 -0
- package/adapters/kimi/templates/extended/agent/agent_skill/starter.md +133 -0
- package/adapters/kimi/templates/extended/agent/hook_policy/review-checklist.md +58 -0
- package/adapters/kimi/templates/extended/agent/hook_policy/starter.md +134 -0
- package/adapters/kimi/templates/extended/agent/prompt_packet/review-checklist.md +54 -0
- package/adapters/kimi/templates/extended/agent/prompt_packet/starter.md +106 -0
- package/adapters/kimi/templates/extended/contracts/api_contract/review-checklist.md +43 -0
- package/adapters/kimi/templates/extended/contracts/api_contract/starter.md +92 -0
- package/adapters/kimi/templates/extended/contracts/batch_job_contract/review-checklist.md +82 -0
- package/adapters/kimi/templates/extended/contracts/batch_job_contract/starter.md +158 -0
- package/adapters/kimi/templates/extended/contracts/cli_contract/review-checklist.md +43 -0
- package/adapters/kimi/templates/extended/contracts/cli_contract/starter.md +93 -0
- package/adapters/kimi/templates/extended/contracts/data_contract/review-checklist.md +45 -0
- package/adapters/kimi/templates/extended/contracts/data_contract/starter.md +88 -0
- package/adapters/kimi/templates/extended/contracts/integration_contract/review-checklist.md +77 -0
- package/adapters/kimi/templates/extended/contracts/integration_contract/starter.md +158 -0
- package/adapters/kimi/templates/extended/contracts/ipc_contract/review-checklist.md +78 -0
- package/adapters/kimi/templates/extended/contracts/ipc_contract/starter.md +214 -0
- package/adapters/kimi/templates/extended/contracts/report_contract/review-checklist.md +61 -0
- package/adapters/kimi/templates/extended/contracts/report_contract/starter.md +97 -0
- package/adapters/kimi/templates/extended/contracts/ui_contract/review-checklist.md +70 -0
- package/adapters/kimi/templates/extended/contracts/ui_contract/starter.md +150 -0
- package/adapters/kimi/templates/extended/domain/database_migration/review-checklist.md +51 -0
- package/adapters/kimi/templates/extended/domain/database_migration/starter.md +115 -0
- package/adapters/kimi/templates/extended/domain/domain_model/review-checklist.md +43 -0
- package/adapters/kimi/templates/extended/domain/domain_model/starter.md +83 -0
- package/adapters/kimi/templates/extended/governance/oss_compliance/review-checklist.md +51 -0
- package/adapters/kimi/templates/extended/governance/oss_compliance/starter.md +84 -0
- package/adapters/kimi/templates/extended/governance/publish_skill/review-checklist.md +58 -0
- package/adapters/kimi/templates/extended/governance/publish_skill/starter.md +172 -0
- package/adapters/kimi/templates/extended/governance/release_policy/review-checklist.md +57 -0
- package/adapters/kimi/templates/extended/governance/release_policy/starter.md +131 -0
- package/adapters/kimi/templates/extended/ops/deployment_manifest/review-checklist.md +51 -0
- package/adapters/kimi/templates/extended/ops/deployment_manifest/starter.md +117 -0
- package/adapters/kimi/templates/extended/ops/migration_plan/review-checklist.md +63 -0
- package/adapters/kimi/templates/extended/ops/migration_plan/starter.md +117 -0
- package/adapters/kimi/templates/extended/ops/performance_budget/review-checklist.md +50 -0
- package/adapters/kimi/templates/extended/ops/performance_budget/starter.md +117 -0
- package/adapters/kimi/templates/extended/ops/runbook/review-checklist.md +51 -0
- package/adapters/kimi/templates/extended/ops/runbook/starter.md +101 -0
- package/adapters/kimi/templates/extended/ops/security_review/review-checklist.md +56 -0
- package/adapters/kimi/templates/extended/ops/security_review/starter.md +125 -0
- package/agent-methods/catalog.yaml +1 -1
- package/compatibility.json +4 -4
- package/docs/.nojekyll +0 -0
- package/docs/00-matrix.html +146 -0
- package/docs/01-what.html +139 -0
- package/docs/02-architecture.html +126 -0
- package/docs/03-concepts.html +176 -0
- package/docs/04-cli.html +163 -0
- package/docs/05-scenarios.html +159 -0
- package/docs/06-method-registry.html +137 -0
- package/docs/07-glossary.html +89 -0
- package/docs/08-maintainer.html +147 -0
- package/docs/09-troubleshoot.html +125 -0
- package/docs/10-roadmap.html +124 -0
- package/docs/assets/style.css +140 -0
- package/docs/assets/terms.js +222 -0
- package/docs/index.html +125 -0
- package/family-apis/catalog.json +1 -1
- package/package.json +20 -3
- package/scripts/build-adapters.mjs +10 -2
- package/scripts/build-runtime-bundles.mjs +1 -1
- package/scripts/check-method-registry.mjs +13 -0
- package/scripts/lib/compatibility-policy.mjs +7 -4
- package/scripts/sync-skills.mjs +6 -0
- package/templates/claude/plugin.json.tpl +2 -2
- package/templates/codex/plugin.json.tpl +1 -1
- package/templates/kimi/plugin.json.tpl +19 -0
|
@@ -16,7 +16,7 @@ instructions.
|
|
|
16
16
|
## Prerequisites
|
|
17
17
|
|
|
18
18
|
- Node.js `>=22.0.0`.
|
|
19
|
-
- `artifact-graph` 0.
|
|
19
|
+
- `artifact-graph` 0.9.0 installed in the target project.
|
|
20
20
|
- **GitHub SSH key** — Claude Code clones `source: github` entries over SSH by default. If you
|
|
21
21
|
have not configured a GitHub SSH key, set `CLAUDE_CODE_PLUGIN_PREFER_HTTPS=1` in your shell
|
|
22
22
|
profile, or add the marketplace with an explicit `https://` URL. Codex users can check
|
|
@@ -28,24 +28,24 @@ instructions.
|
|
|
28
28
|
|
|
29
29
|
| Plugin | Verified Runtime | Install |
|
|
30
30
|
| --- | --- | --- |
|
|
31
|
-
| `artifact-chain-assistant` 0.
|
|
31
|
+
| `artifact-chain-assistant` 0.9.0 | `artifact-graph` 0.9.0 | `pnpm add -D artifact-graph@0.9.0` |
|
|
32
32
|
|
|
33
33
|
### Install The Runtime
|
|
34
34
|
|
|
35
35
|
The default installation path uses the npm registry with a precise version:
|
|
36
36
|
|
|
37
37
|
```bash
|
|
38
|
-
pnpm add -D artifact-graph@0.
|
|
38
|
+
pnpm add -D artifact-graph@0.9.0
|
|
39
39
|
```
|
|
40
40
|
|
|
41
41
|
If the npm registry is unavailable, use the explicit GitHub fallback pinned to the verified tag:
|
|
42
42
|
|
|
43
43
|
```bash
|
|
44
|
-
pnpm add -D github:ifoohoo/artifact-graph#artifact-graph-v0.
|
|
44
|
+
pnpm add -D github:ifoohoo/artifact-graph#artifact-graph-v0.9.0
|
|
45
45
|
```
|
|
46
46
|
|
|
47
47
|
> **Never** install with an unlocked range (`artifact-graph`, `artifact-graph@latest`,
|
|
48
|
-
> `artifact-graph@^0.
|
|
48
|
+
> `artifact-graph@^0.9.0`) or an unpinned GitHub URL (`github:ifoohoo/artifact-graph`).
|
|
49
49
|
> Unlocked installs produce non-reproducible dependency trees and break version-lock audit.
|
|
50
50
|
|
|
51
51
|
With pnpm 10+, projects that install `artifact-graph` must allow the native `better-sqlite3`
|
|
@@ -72,7 +72,7 @@ allowBuilds:
|
|
|
72
72
|
|
|
73
73
|
The plugin's `doctor` command validates the installed runtime version before running any
|
|
74
74
|
diagnostic. If it detects a version mismatch or missing CLI, it reports the exact remediation
|
|
75
|
-
command (`pnpm add -D artifact-graph@0.
|
|
75
|
+
command (`pnpm add -D artifact-graph@0.9.0`) and exits non-zero.
|
|
76
76
|
|
|
77
77
|
### CLI Resolution Order
|
|
78
78
|
|
|
@@ -147,9 +147,33 @@ wrappers, and Stop-hook guardrail. These assistant controls do not replace Git h
|
|
|
147
147
|
|
|
148
148
|
> **Marketplace note**: `ifoohoo/artifact-skill-set` is an external independent marketplace. The
|
|
149
149
|
> plugin payload is still published from `ifoohoo/artifact-chain-assistant`. The marketplace entry
|
|
150
|
-
> must publish and enable `artifact-chain-assistant` 0.
|
|
150
|
+
> must publish and enable `artifact-chain-assistant` 0.9.0 before the install commands above will
|
|
151
151
|
> succeed.
|
|
152
152
|
|
|
153
|
+
### Kimi Code
|
|
154
|
+
|
|
155
|
+
Kimi Code installs plugins interactively from a GitHub URL (per-user scope, applies to all
|
|
156
|
+
projects):
|
|
157
|
+
|
|
158
|
+
```text
|
|
159
|
+
/plugins install https://github.com/ifoohoo/artifact-chain-assistant
|
|
160
|
+
```
|
|
161
|
+
|
|
162
|
+
To upgrade, run the same install command again. After installing or upgrading, run `/reload`
|
|
163
|
+
(or start a new session) so the plugin skills are picked up.
|
|
164
|
+
|
|
165
|
+
For a monorepo checkout, install from the local plugin root or the Kimi adapter directory:
|
|
166
|
+
|
|
167
|
+
```text
|
|
168
|
+
/plugins install <absolute-path>/plugins/artifact-chain-assistant
|
|
169
|
+
```
|
|
170
|
+
|
|
171
|
+
The Kimi Code adapter exposes the same surface as the Codex adapter: the plugin manifest,
|
|
172
|
+
skills, and managed scripts (`doctor.mjs`, `check-workflow-profile.mjs`, `run-artifact-workflow.mjs`, `batch-split.mjs`,
|
|
173
|
+
`batch-merge.mjs`). It does not expose plugin commands, hooks, or settings. Kimi Code has no
|
|
174
|
+
non-interactive install CLI, so automated install verification is limited to layout checks;
|
|
175
|
+
use `artifact-chain-maintainer` to guide version-lock CLI operations.
|
|
176
|
+
|
|
153
177
|
## Post-Installation Discovery
|
|
154
178
|
|
|
155
179
|
After installing the plugin, use these entry points to understand available capabilities:
|
|
@@ -197,7 +221,7 @@ The plugin should not move these files into the plugin repository.
|
|
|
197
221
|
|
|
198
222
|
For a first-time setup, the end-to-end sequence is:
|
|
199
223
|
|
|
200
|
-
1. **Install the CLI** — `pnpm add -D artifact-graph@0.
|
|
224
|
+
1. **Install the CLI** — `pnpm add -D artifact-graph@0.9.0` (see Prerequisites above).
|
|
201
225
|
2. **Install the plugin** — follow the Codex or Claude Code section above.
|
|
202
226
|
3. **Run bootstrap** — ask the assistant to use the `artifact-chain-bootstrap` skill (see prompt
|
|
203
227
|
below). The skill will:
|
|
@@ -271,7 +295,7 @@ with execution evidence.
|
|
|
271
295
|
|
|
272
296
|
The workflow profile schema is at `$PLUGIN_ROOT/schemas/artifact-workflow-profile.schema.json`
|
|
273
297
|
and the shared validation library is at `$PLUGIN_ROOT/scripts/lib/workflow-profile.mjs`. Both
|
|
274
|
-
are automatically synced to Codex and
|
|
298
|
+
are automatically synced to Codex, Claude Code, and Kimi Code adapter roots during the runtime bundle build.
|
|
275
299
|
|
|
276
300
|
### Guided Setup With The Bootstrap Skill
|
|
277
301
|
|
|
@@ -995,10 +1019,10 @@ with append-only behavior; it does not overwrite local rules.
|
|
|
995
1019
|
### Recovery Steps
|
|
996
1020
|
|
|
997
1021
|
```bash
|
|
998
|
-
# 1. Install dependencies from lockfile (gets artifact-graph@0.
|
|
1022
|
+
# 1. Install dependencies from lockfile (gets artifact-graph@0.9.0)
|
|
999
1023
|
pnpm install --frozen-lockfile
|
|
1000
1024
|
|
|
1001
|
-
# 2. Install plugin per your host (Codex / Claude Code)
|
|
1025
|
+
# 2. Install plugin per your host (Codex / Claude Code / Kimi Code)
|
|
1002
1026
|
# Each machine must install the plugin separately if the host
|
|
1003
1027
|
# does not auto-restore from project declarations.
|
|
1004
1028
|
```
|
|
@@ -1062,7 +1086,7 @@ pnpm exec artifact-graph hooks install-git --hook all
|
|
|
1062
1086
|
### Enterprise Mirror
|
|
1063
1087
|
|
|
1064
1088
|
If the corporate environment cannot access the public npm registry or GitHub, mirror both
|
|
1065
|
-
`artifact-graph@0.
|
|
1089
|
+
`artifact-graph@0.9.0` and the plugin marketplace repository on an internal registry. The mirror
|
|
1066
1090
|
does not change the state ownership model: Git-tracked files remain authoritative, local caches
|
|
1067
1091
|
remain derived.
|
|
1068
1092
|
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
{
|
|
2
2
|
"schemaVersion": "1.0",
|
|
3
|
-
"pluginVersion": "0.
|
|
3
|
+
"pluginVersion": "0.9.0",
|
|
4
4
|
"artifactGraph": {
|
|
5
|
-
"verifiedVersion": "0.
|
|
6
|
-
"installSpec": "artifact-graph@0.
|
|
7
|
-
"githubFallbackSpec": "github:ifoohoo/artifact-graph#artifact-graph-v0.
|
|
5
|
+
"verifiedVersion": "0.9.0",
|
|
6
|
+
"installSpec": "artifact-graph@0.9.0",
|
|
7
|
+
"githubFallbackSpec": "github:ifoohoo/artifact-graph#artifact-graph-v0.9.0"
|
|
8
8
|
}
|
|
9
9
|
}
|
|
@@ -96,21 +96,22 @@ export async function validateCompatibilityPolicy(pluginRoot) {
|
|
|
96
96
|
// Check package.json version
|
|
97
97
|
await checkJsonField(pluginRoot, 'package.json', 'version', pluginVersion, issues);
|
|
98
98
|
|
|
99
|
-
// Check adapter manifest versions (real paths: .codex-plugin/plugin.json, .claude-plugin/plugin.json)
|
|
99
|
+
// Check adapter manifest versions (real paths: .codex-plugin/plugin.json, .claude-plugin/plugin.json, .kimi-plugin/plugin.json)
|
|
100
100
|
for (const [adapter, manifestRel] of [
|
|
101
101
|
['codex', join('adapters', 'codex', '.codex-plugin', 'plugin.json')],
|
|
102
102
|
['claude', join('adapters', 'claude', '.claude-plugin', 'plugin.json')],
|
|
103
|
+
['kimi', join('adapters', 'kimi', '.kimi-plugin', 'plugin.json')],
|
|
103
104
|
]) {
|
|
104
105
|
await checkAdapterManifest(pluginRoot, adapter, manifestRel, pluginVersion, issues);
|
|
105
106
|
}
|
|
106
107
|
|
|
107
108
|
// Check adapter compatibility.json deep match against root policy
|
|
108
|
-
for (const adapter of ['codex', 'claude']) {
|
|
109
|
+
for (const adapter of ['codex', 'claude', 'kimi']) {
|
|
109
110
|
await checkAdapterCompatibility(pluginRoot, adapter, policy, issues);
|
|
110
111
|
}
|
|
111
112
|
|
|
112
113
|
// Check adapter doctor and lib files exist
|
|
113
|
-
for (const adapter of ['codex', 'claude']) {
|
|
114
|
+
for (const adapter of ['codex', 'claude', 'kimi']) {
|
|
114
115
|
await checkAdapterDoctorFiles(pluginRoot, adapter, issues);
|
|
115
116
|
}
|
|
116
117
|
|
|
@@ -279,7 +280,8 @@ function classifyInstallSpecViolation(line, expectedInstallSpec, expectedGithubS
|
|
|
279
280
|
/**
|
|
280
281
|
* Check public docs for forbidden install patterns.
|
|
281
282
|
* Scans real public snapshot files at plugin root:
|
|
282
|
-
* INSTALL.md, README.md, README.zh-CN.md, adapters/codex/INSTALL.md, adapters/claude/INSTALL.md
|
|
283
|
+
* INSTALL.md, README.md, README.zh-CN.md, adapters/codex/INSTALL.md, adapters/claude/INSTALL.md,
|
|
284
|
+
* adapters/kimi/INSTALL.md
|
|
283
285
|
*
|
|
284
286
|
* For each fenced code block line, extracts the artifact-graph package spec
|
|
285
287
|
* from any argument position and classifies it — no enumeration of flag orderings.
|
|
@@ -296,6 +298,7 @@ async function checkDocsForForbiddenPatterns(pluginRoot, artifactGraphPolicy, is
|
|
|
296
298
|
'README.zh-CN.md',
|
|
297
299
|
join('adapters', 'codex', 'INSTALL.md'),
|
|
298
300
|
join('adapters', 'claude', 'INSTALL.md'),
|
|
301
|
+
join('adapters', 'kimi', 'INSTALL.md'),
|
|
299
302
|
];
|
|
300
303
|
|
|
301
304
|
for (const relPath of docPaths) {
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "artifact-chain-assistant",
|
|
3
|
+
"version": "0.9.0",
|
|
4
|
+
"description": "Artifact-chain intake, review/repair/batch/audit workflows, diagnostics, and version-lock maintenance helpers.",
|
|
5
|
+
"author": {
|
|
6
|
+
"name": "广州市风荷科技有限公司"
|
|
7
|
+
},
|
|
8
|
+
"license": "Apache-2.0",
|
|
9
|
+
"homepage": "https://github.com/ifoohoo/artifact-chain-assistant#readme",
|
|
10
|
+
"keywords": ["artifact-graph", "traceability", "kimi-code"],
|
|
11
|
+
"skills": "./skills/",
|
|
12
|
+
"interface": {
|
|
13
|
+
"displayName": "Artifact Chain Assistant",
|
|
14
|
+
"shortDescription": "Artifact-chain context, review workflows, and version-lock maintenance.",
|
|
15
|
+
"longDescription": "Reusable skills for artifact-graph projects, including intake routing, generic artifact review/repair/batch/audit workflows, diagnostics, and version-lock refresh guidance.",
|
|
16
|
+
"developerName": "广州市风荷科技有限公司",
|
|
17
|
+
"websiteURL": "https://github.com/ifoohoo/artifact-chain-assistant"
|
|
18
|
+
}
|
|
19
|
+
}
|
|
@@ -0,0 +1,315 @@
|
|
|
1
|
+
# Extended Artifact Catalog
|
|
2
|
+
|
|
3
|
+
<!-- generated by scripts/render-public-docs.mjs from docs/public/** — do not edit directly -->
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
This document summarizes the extended artifact type catalog for `artifact-chain-assistant`. It
|
|
7
|
+
covers type classification, recommended paths and ID patterns, template adoption rules, and the
|
|
8
|
+
three-tier authority boundary between `artifact-graph`, the plugin, and target projects.
|
|
9
|
+
|
|
10
|
+
For core artifact types (`feature`, `scenario`, `decision`, `design`, `test`, `e2e_test`), see the
|
|
11
|
+
plugin README and INSTALL.md. This document covers opt-in types beyond the core set.
|
|
12
|
+
|
|
13
|
+
## Three-Tier Authority Model
|
|
14
|
+
|
|
15
|
+
| Layer | Scope | Responsibility for Extended Types |
|
|
16
|
+
| --- | --- | --- |
|
|
17
|
+
| **artifact-graph** | Deterministic graph capabilities | Reads type definitions from config; indexes artifacts; provides context/packet/validate. Does **not** ship default paths or ID patterns for extended types. Types without configured paths are not indexed. |
|
|
18
|
+
| **artifact-chain-assistant** | General assistant guidance | Provides starter templates, profile suggestions, and generic review checklists. **Templates are guidance, not authority.** Project-local templates and review skills override plugin suggestions. |
|
|
19
|
+
| **Target project** | Final working method | Decides which extended types to enable; maintains config, local templates, review skills, and ID rules. **Project-local overrides plugin suggestions.** Enables new types progressively as maturity grows. |
|
|
20
|
+
|
|
21
|
+
## Extended Artifact Type Catalog
|
|
22
|
+
|
|
23
|
+
Extended types are organized into four categories. Each type entry includes recommended paths, ID
|
|
24
|
+
patterns, lifecycle rules, and review checkpoints. All recommended values are **guidance** — the
|
|
25
|
+
project's `artifact-graph.config.yaml` is the final authority.
|
|
26
|
+
|
|
27
|
+
### Contract Artifacts
|
|
28
|
+
|
|
29
|
+
Contract artifacts record interface agreements at system boundaries. When requirements flow from
|
|
30
|
+
features and scenarios into implementation, contracts are key upstream artifacts for context
|
|
31
|
+
assembly.
|
|
32
|
+
|
|
33
|
+
| Type | Recommended Path | Recommended ID Pattern | Lifecycle | Review Checkpoints |
|
|
34
|
+
| --- | --- | --- | --- | --- |
|
|
35
|
+
| `api_contract` | `artifacts/contracts/api/` | `API-{nnn}` or `{service}-API-{version}` | Create/update on API change; mark deprecated when API is retired | Consistency with implementation, error code coverage, version compatibility, request/response schema completeness |
|
|
36
|
+
| `cli_contract` | `artifacts/contracts/cli/` | `CLI-{nnn}` or `{tool}-CLI-{version}` | Create/update on CLI interface change | Command signature, parameter types, exit codes, backward compatibility, help text accuracy |
|
|
37
|
+
| `ui_contract` | `artifacts/contracts/ui/` | `UI-{nnn}` | Create/update on UI flow change | Interaction flows, state transitions, accessibility, error state coverage |
|
|
38
|
+
| `ipc_contract` | `artifacts/contracts/ipc/` | `IPC-{nnn}` | Create/update on IPC channel change | Message format, error propagation, frontend/backend boundary, serialization compatibility |
|
|
39
|
+
| `data_contract` | `artifacts/contracts/data/` | `DATA-{nnn}` | Create/update on data model/schema change | Field semantics, version compatibility, migration path, default value semantics |
|
|
40
|
+
| `report_contract` | `artifacts/contracts/report/` | `RPT-{nnn}` | Create/update on report format change | Field semantics, aggregation logic, output format, time window semantics |
|
|
41
|
+
| `integration_contract` | `artifacts/contracts/integration/` | `INT-{nnn}` | Create/update on external system integration change | Interface protocol, timeout, retry strategy, idempotency, error classification |
|
|
42
|
+
| `batch_job_contract` | `artifacts/contracts/batch/` | `BATCH-{nnn}` | Create/update on batch job change | Input/output format, schedule expression, idempotency, error handling, replay strategy |
|
|
43
|
+
|
|
44
|
+
### Domain and Data Artifacts
|
|
45
|
+
|
|
46
|
+
Domain and data artifacts capture business concepts and technical data models. They are core
|
|
47
|
+
artifacts for enterprise Java and DDD projects.
|
|
48
|
+
|
|
49
|
+
| Type | Recommended Path | Recommended ID Pattern | Lifecycle | Review Checkpoints |
|
|
50
|
+
| --- | --- | --- | --- | --- |
|
|
51
|
+
| `domain_model` | `artifacts/domain/` | `DM-{nnn}` or entity name | Create/update on domain concept change | Aggregate boundaries, domain events, bounded context mapping, invariant definitions |
|
|
52
|
+
| `database_migration` | `artifacts/migrations/` | `MIG-{nnn}` or timestamp (e.g., `20260709-001`) | Create on schema change; mark executed after deployment | Rollback path, data compatibility, performance impact, large table change strategy |
|
|
53
|
+
|
|
54
|
+
### Deployment and Operations Artifacts
|
|
55
|
+
|
|
56
|
+
Deployment and operations artifacts cover production environment changes, security, performance, and
|
|
57
|
+
operational procedures. Enable only when the project has corresponding operational processes.
|
|
58
|
+
|
|
59
|
+
| Type | Recommended Path | Recommended ID Pattern | Lifecycle | Review Checkpoints |
|
|
60
|
+
| --- | --- | --- | --- | --- |
|
|
61
|
+
| `deployment_manifest` | `artifacts/deploy/` | `DEP-{nnn}` or environment name (e.g., `DEP-prod`) | Create/update on deployment config change | Environment differences, rollback strategy, resource limits, health check configuration |
|
|
62
|
+
| `security_review` | `artifacts/security/` | `SEC-{nnn}` | Create/update on security review cycle or major change | Threat model coverage, fix status tracking, compliance mapping, sensitive data handling |
|
|
63
|
+
| `performance_budget` | `artifacts/performance/` | `PERF-{nnn}` | Create/update on performance target change | Metric baseline, threshold definition, regression detection strategy, measurement method |
|
|
64
|
+
| `migration_plan` | `artifacts/migrations/plan/` | `MPLAN-{nnn}` | Create on migration start; update at each phase completion | Phase division, rollback point definition, data validation strategy, parallel run period |
|
|
65
|
+
| `runbook` | `artifacts/runbooks/` | `RUN-{nnn}` | Create/update on operational procedure change | Step accuracy, alert correlation, responsible person, last execution date |
|
|
66
|
+
|
|
67
|
+
### Release Governance Artifacts
|
|
68
|
+
|
|
69
|
+
Release governance artifacts cover versioning strategy, publishing workflows, and open-source
|
|
70
|
+
compliance. Enable only for parent repos, release governance repos, or multi-package monorepos that
|
|
71
|
+
own the release process.
|
|
72
|
+
|
|
73
|
+
| Type | Recommended Path | Recommended ID Pattern | Lifecycle | Review Checkpoints |
|
|
74
|
+
| --- | --- | --- | --- | --- |
|
|
75
|
+
| `release_policy` | `artifacts/governance/` | `RP-{nnn}` | Create/update on release policy change | Version semantics, release cadence, branch strategy, changelog standard, rollback plan |
|
|
76
|
+
| `publish_skill` | `artifacts/governance/` | `PS-{nnn}` | Create/update on publish workflow change | Publish targets, quality gates, compliance checks, error handling, rollback plan |
|
|
77
|
+
| `oss_compliance` | `artifacts/governance/` | `OSS-{nnn}` | Create/update on OSS compliance rule or release scope change | License policy, dependency audit, standard files, security disclosure, release exclusions |
|
|
78
|
+
|
|
79
|
+
### Agent and Hook Artifacts
|
|
80
|
+
|
|
81
|
+
Agent and hook artifacts cover AI-assisted workflows and CI/CD gates. Enable only when the project
|
|
82
|
+
has corresponding files or processes.
|
|
83
|
+
|
|
84
|
+
| Type | Recommended Path | Recommended ID Pattern | Lifecycle | Review Checkpoints |
|
|
85
|
+
| --- | --- | --- | --- | --- |
|
|
86
|
+
| `agent_skill` | `artifacts/skills/` | `SKILL-{nnn}` | Create/update on skill definition change | Input/output contract, tool dependencies, permission boundary, error handling |
|
|
87
|
+
| `hook_policy` | `artifacts/policies/` | `HOOK-{nnn}` | Create/update on hook policy change | Trigger conditions, gate rules, bypass approval process, audit log |
|
|
88
|
+
| `prompt_packet` | `artifacts/packets/` | `PP-{nnn}` | Create/update on prompt template or context assembly change | Context sources, prompt clarity, token budget, output contract, testability |
|
|
89
|
+
|
|
90
|
+
## Bootstrap Trimming Strategy
|
|
91
|
+
|
|
92
|
+
Bootstrap selects a **minimum viable profile** rather than enabling all known types.
|
|
93
|
+
|
|
94
|
+
Rules:
|
|
95
|
+
|
|
96
|
+
1. **Core set always enabled**: `feature`, `scenario`, `decision`, `design`, `test`, `e2e_test`.
|
|
97
|
+
2. **Contracts by evidence**: Enable only when the project has corresponding interface files (e.g., OpenAPI spec, CLI entry, IPC channel definition).
|
|
98
|
+
3. **Domain/data by project shape**: Enterprise Java/DDD projects may enable `domain_model`; projects with databases may enable `database_migration`.
|
|
99
|
+
4. **Ops by operational process**: Enable only when the project has deployment configs, security review processes, or operational manuals.
|
|
100
|
+
5. **Agent/hook by local files**: Enable only when the project has `skills/`, `policies/`, or hook config files.
|
|
101
|
+
6. **Progressive expansion**: As project maturity grows, add new types in `artifact-graph.config.yaml`. Existing artifacts and traceability relationships are unaffected.
|
|
102
|
+
|
|
103
|
+
After bootstrap, the enabled types, paths, and ID patterns are recorded in
|
|
104
|
+
`artifact-graph.config.yaml`. Deferred types and their evidence conditions are documented in the
|
|
105
|
+
project's artifact catalog so future expansion is a recorded decision.
|
|
106
|
+
|
|
107
|
+
## Template Adoption
|
|
108
|
+
|
|
109
|
+
### Template Source Rules
|
|
110
|
+
|
|
111
|
+
1. **Plugin templates are onboarding guidance.** `artifact-chain-assistant` provides starter
|
|
112
|
+
templates for each extended type in `templates/extended/`, organized by category
|
|
113
|
+
(`contracts/`, `domain/`, `ops/`, `agent/`). Plugin templates do not determine the project's
|
|
114
|
+
artifact shape.
|
|
115
|
+
2. **Project-local templates are authority.** When a project needs different section structures,
|
|
116
|
+
review standards, or naming rules, project-local templates override plugin templates.
|
|
117
|
+
3. **Fallback when no template exists.** If a project enables an extended type but has no local
|
|
118
|
+
template, the assistant may reference the plugin starter but must note it has not been
|
|
119
|
+
customized.
|
|
120
|
+
4. **Adoption flow.** Copy the starter template from `templates/extended/` to the project-local
|
|
121
|
+
`artifacts/templates/` or equivalent, then customize.
|
|
122
|
+
|
|
123
|
+
### Template Lifecycle
|
|
124
|
+
|
|
125
|
+
1. **Bootstrap phase**: Bootstrap skill references plugin starters to generate initial artifact
|
|
126
|
+
structure. Template source is recorded in `artifacts/README.md`.
|
|
127
|
+
2. **Adoption phase**: Team reviews the starter, decides which sections to keep/modify/remove,
|
|
128
|
+
and copies to local. The customized version becomes authority.
|
|
129
|
+
3. **Mature phase**: Project maintains a complete local template library. Plugin starters are
|
|
130
|
+
referenced only when onboarding new members or enabling new types.
|
|
131
|
+
4. **Upgrade review**: When the plugin updates a starter, the project reviews the diff and
|
|
132
|
+
selectively merges useful changes while preserving local customizations.
|
|
133
|
+
|
|
134
|
+
### Template Directory Layout
|
|
135
|
+
|
|
136
|
+
```
|
|
137
|
+
templates/
|
|
138
|
+
core/ # Core artifact templates
|
|
139
|
+
feature/
|
|
140
|
+
starter.md # Drafting guidance template
|
|
141
|
+
review-checklist.md # Generic review checklist
|
|
142
|
+
scenario/
|
|
143
|
+
starter.md
|
|
144
|
+
review-checklist.md
|
|
145
|
+
decision/
|
|
146
|
+
starter.md
|
|
147
|
+
review-checklist.md
|
|
148
|
+
design/
|
|
149
|
+
starter.md
|
|
150
|
+
review-checklist.md
|
|
151
|
+
test/
|
|
152
|
+
starter.md
|
|
153
|
+
review-checklist.md
|
|
154
|
+
e2e_test/
|
|
155
|
+
starter.md
|
|
156
|
+
review-checklist.md
|
|
157
|
+
extended/ # Extended artifact templates (by category)
|
|
158
|
+
contracts/
|
|
159
|
+
api_contract/
|
|
160
|
+
starter.md
|
|
161
|
+
review-checklist.md
|
|
162
|
+
cli_contract/
|
|
163
|
+
starter.md
|
|
164
|
+
review-checklist.md
|
|
165
|
+
data_contract/
|
|
166
|
+
starter.md
|
|
167
|
+
review-checklist.md
|
|
168
|
+
... # Other contract types follow the same structure
|
|
169
|
+
domain/
|
|
170
|
+
domain_model/
|
|
171
|
+
starter.md
|
|
172
|
+
review-checklist.md
|
|
173
|
+
database_migration/
|
|
174
|
+
starter.md
|
|
175
|
+
review-checklist.md
|
|
176
|
+
ops/
|
|
177
|
+
deployment_manifest/
|
|
178
|
+
starter.md
|
|
179
|
+
review-checklist.md
|
|
180
|
+
runbook/
|
|
181
|
+
starter.md
|
|
182
|
+
review-checklist.md
|
|
183
|
+
...
|
|
184
|
+
governance/
|
|
185
|
+
release_policy/
|
|
186
|
+
starter.md
|
|
187
|
+
review-checklist.md
|
|
188
|
+
publish_skill/
|
|
189
|
+
starter.md
|
|
190
|
+
review-checklist.md
|
|
191
|
+
oss_compliance/
|
|
192
|
+
starter.md
|
|
193
|
+
review-checklist.md
|
|
194
|
+
agent/
|
|
195
|
+
agent_skill/
|
|
196
|
+
starter.md
|
|
197
|
+
review-checklist.md
|
|
198
|
+
hook_policy/
|
|
199
|
+
starter.md
|
|
200
|
+
review-checklist.md
|
|
201
|
+
prompt_packet/
|
|
202
|
+
starter.md
|
|
203
|
+
review-checklist.md
|
|
204
|
+
```
|
|
205
|
+
|
|
206
|
+
Each type's `starter.md` contains the artifact structure template and minimal filling guidance.
|
|
207
|
+
`review-checklist.md` is the generic review checkpoint baseline. Both are **suggestions that can be
|
|
208
|
+
fully overridden by project-local templates**.
|
|
209
|
+
|
|
210
|
+
## Evidence-Based Enablement
|
|
211
|
+
|
|
212
|
+
Bootstrap activates extended artifact types only when local files or directories exist:
|
|
213
|
+
|
|
214
|
+
| Type | Enablement Evidence |
|
|
215
|
+
| --- | --- |
|
|
216
|
+
| `api_contract` | OpenAPI/Swagger spec, API documentation, or REST endpoint code exists |
|
|
217
|
+
| `cli_contract` | CLI entry code or command definitions exist |
|
|
218
|
+
| `data_contract` | Data model definitions or schema files exist |
|
|
219
|
+
| `domain_model` | DDD aggregates, entities, or value objects exist in code |
|
|
220
|
+
| `database_migration` | Database schema or migration scripts exist |
|
|
221
|
+
| `security_review` | Security review process, security-related code, or Spring Security config exists |
|
|
222
|
+
| `performance_budget` | Performance test scripts, monitoring config, or performance baseline docs exist |
|
|
223
|
+
| `migration_plan` | Migration planning docs, architecture evolution plans, or system transition plans exist |
|
|
224
|
+
| `runbook` | Operational procedures or runbook documents exist |
|
|
225
|
+
| `deployment_manifest` | Deployment configs (K8s, Docker, etc.) exist |
|
|
226
|
+
| `agent_skill` | Agent skill definition files exist |
|
|
227
|
+
| `hook_policy` | CI/CD hook configurations exist |
|
|
228
|
+
| `release_policy` | Release policy docs, versioning strategy, or release process files exist |
|
|
229
|
+
| `publish_skill` | Publish workflow scripts, CI/CD publish pipelines, or registry configuration exists |
|
|
230
|
+
| `prompt_packet` | Prompt template files, context assembly configs, or AI workflow definitions exist |
|
|
231
|
+
| `oss_compliance` | License files, dependency audit configs, or OSS compliance process docs exist |
|
|
232
|
+
|
|
233
|
+
**Rule**: Enable a type only when local evidence exists. Do not enable because the plugin provides a
|
|
234
|
+
template.
|
|
235
|
+
|
|
236
|
+
## artifact-graph Runtime Support for Custom Types
|
|
237
|
+
|
|
238
|
+
Starting with `artifact-graph` 0.3.0, config-driven custom types have full runtime support.
|
|
239
|
+
The extended catalog has two layers:
|
|
240
|
+
|
|
241
|
+
1. **Implemented in artifact-chain-assistant**: starter templates, review checklists, bootstrap
|
|
242
|
+
recommendations, and evidence-based adoption guidance.
|
|
243
|
+
2. **Implemented in artifact-graph 0.3.0+**: config-driven indexing, graph traversal, `context`,
|
|
244
|
+
`packet`, `validate`, `version-lock`, and `extraFields` for any registered custom type.
|
|
245
|
+
|
|
246
|
+
### What the Runtime Provides for Custom Types
|
|
247
|
+
|
|
248
|
+
Once a type is registered in `artifact-graph.config.yaml` with `paths` and optionally
|
|
249
|
+
`idPatterns`, the runtime delivers:
|
|
250
|
+
|
|
251
|
+
1. **Scanning and frontmatter parsing**: Read `types.{type}.paths` from config; scan matching
|
|
252
|
+
files; parse frontmatter for `id`, `title`, `status` and other standard fields. Types without
|
|
253
|
+
configured paths are not indexed.
|
|
254
|
+
2. **Graph edges**: Custom types participate in graph traversal through `related_<type>`
|
|
255
|
+
frontmatter fields, `@<type> <ID>` traceability comments, and explicit relationship fields.
|
|
256
|
+
3. **Target selector**: `--target <type>:<id>` works with `context`, `packet`, `packet-prompt`,
|
|
257
|
+
and `audit` for any type that has `target: true` in config. The ID may contain colons; only the
|
|
258
|
+
first colon separates type from ID. There is **no** dynamic `--{type}` flag; `--target` is the
|
|
259
|
+
universal entry point.
|
|
260
|
+
4. **Extra fields**: Declare `extraFields` in config to index specific frontmatter fields (string,
|
|
261
|
+
number, boolean, enum). Undeclared fields remain in raw frontmatter but are not indexed.
|
|
262
|
+
5. **Validation**: Custom types participate in ID pattern checks, dangling relation warnings, orphan
|
|
263
|
+
artifact warnings, and version-lock freshness checks.
|
|
264
|
+
6. **Version-lock**: Custom type artifacts and their traceability edges are included in
|
|
265
|
+
version-lock refresh, audit, and bootstrap.
|
|
266
|
+
|
|
267
|
+
### Capability Matrix
|
|
268
|
+
|
|
269
|
+
| Capability | Core Types | Extended Types | Notes |
|
|
270
|
+
| --- | --- | --- | --- |
|
|
271
|
+
| File indexing and ID parsing | Implemented | Implemented via config `paths` + `idPatterns` | Types without configured paths are not indexed |
|
|
272
|
+
| Graph traversal (upstream/downstream) | Implemented | Implemented via `related_<type>` fields and traceability comments | Strength depends on traceability annotation density |
|
|
273
|
+
| context/packet assembly | Implemented (`--target <type>:<id>`) | Implemented (`--target <type>:<id>`) | `--target` is the universal entry; no dynamic `--{type}` flags |
|
|
274
|
+
| validate | Implemented | Implemented | ID pattern checks, dangling relations, orphan warnings, lock freshness |
|
|
275
|
+
| version-lock | Implemented | Implemented | Custom type edges included in refresh/audit/bootstrap |
|
|
276
|
+
| Artifact content quality judgment | No | No | artifact-graph does not judge "good PRD" or "good contract" |
|
|
277
|
+
| Built-in edge rules | No | No | All edge rules come from artifact content, not type metadata |
|
|
278
|
+
|
|
279
|
+
### Known Limitations
|
|
280
|
+
|
|
281
|
+
- **Content quality not judged**: artifact-graph validates structure and traceability, not whether
|
|
282
|
+
an artifact's content is well-written or complete.
|
|
283
|
+
- **Sparse traceability annotations**: Custom artifacts without `related_*` frontmatter fields or
|
|
284
|
+
implementation traceability comments will produce weak graph relationships. Mitigation:
|
|
285
|
+
project-local review should require traceability fields.
|
|
286
|
+
- **ID pattern collisions**: Multiple types using the same ID pattern can cause ambiguous graph
|
|
287
|
+
edges. Mitigation: use distinct ID prefixes per type (e.g., `API-`, `CLI-`).
|
|
288
|
+
- **Path overlaps**: Multiple types whose path globs match the same files create duplicate graph
|
|
289
|
+
nodes. Mitigation: use mutually exclusive path globs.
|
|
290
|
+
- **Loosely-coupled ops artifacts**: Some types (e.g., `runbook`, `deployment_manifest`) may have
|
|
291
|
+
naturally loose links to the core requirement chain. This is expected behavior, not a defect.
|
|
292
|
+
|
|
293
|
+
## Project Shape Profiles
|
|
294
|
+
|
|
295
|
+
Nine project profiles each map to a recommended starter set and a defer-until-ready list. Profiles
|
|
296
|
+
are used only during bootstrap — they are not a runtime concept. The final selection is written to
|
|
297
|
+
`artifact-graph.config.yaml`.
|
|
298
|
+
|
|
299
|
+
| Profile | Recommended Extended Types | Deferred Types |
|
|
300
|
+
| --- | --- | --- |
|
|
301
|
+
| Docs/planning repo | None | All extended types |
|
|
302
|
+
| TypeScript library or CLI | `cli_contract` | Other contracts, domain, ops |
|
|
303
|
+
| API service | `api_contract`, `data_contract` | `domain_model`, `deployment_manifest`, `runbook`, `performance_budget` |
|
|
304
|
+
| Enterprise Java/Spring/JVM | `api_contract`, `data_contract`, `integration_contract`, `batch_job_contract`, `domain_model`, `database_migration`, `security_review` | `deployment_manifest`, `runbook`, `performance_budget` |
|
|
305
|
+
| Desktop or full-stack app | `ui_contract`, `ipc_contract`, `api_contract` | `deployment_manifest`, `runbook` |
|
|
306
|
+
| Agent or plugin toolkit | `agent_skill`, `hook_policy`, `prompt_packet` | Other extended types |
|
|
307
|
+
| Parent or release governance repo | `release_policy`, `publish_skill`, `oss_compliance` | Other extended types |
|
|
308
|
+
| Existing mature artifact repo | As-needed based on existing files | Types without local evidence |
|
|
309
|
+
| Small first-time project | None | All extended types |
|
|
310
|
+
|
|
311
|
+
## Related Documents
|
|
312
|
+
|
|
313
|
+
- [README](templates/README.md) — Plugin overview with full feature list
|
|
314
|
+
- [INSTALL.md](INSTALL.md) — Installation, bootstrap flow, and profile expansion guide
|
|
315
|
+
- [ADOPTION-GUIDE](https://github.com/ifoohoo/artifact-chain-assistant/blob/main/templates/extended/ADOPTION-GUIDE.md) — Step-by-step template adoption and upgrade review guide
|