agent-cli-runtime 0.1.0-alpha.1 → 0.1.0-alpha.3
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/CHANGELOG.md +34 -0
- package/README.md +45 -9
- package/README.zh-CN.md +45 -9
- package/dist/cli/main.js +0 -0
- package/dist/core/schema-contract.d.ts +10 -0
- package/dist/core/schema-contract.js +36 -0
- package/dist/core/schema-contract.js.map +1 -1
- package/docs/api-schema-contract.md +14 -3
- package/docs/compatibility.md +82 -30
- package/docs/daemon-ready-contract.md +51 -0
- package/docs/production-readiness.md +44 -15
- package/docs/release-checklist.md +127 -266
- package/docs/release-publish-runbook.md +45 -39
- package/docs/release-report.md +72 -472
- package/docs/ssot.md +48 -32
- package/package.json +12 -3
|
@@ -1,34 +1,41 @@
|
|
|
1
1
|
# Alpha Publish Readiness Runbook
|
|
2
2
|
|
|
3
|
-
Status: 0.1.0-alpha.
|
|
4
|
-
Last updated: 2026-06-
|
|
3
|
+
Status: `0.1.0-alpha.3` corrective pre-alpha release; registry mutations remain human-controlled
|
|
4
|
+
Last updated: 2026-06-26
|
|
5
5
|
|
|
6
|
-
This runbook
|
|
6
|
+
This runbook records the publish and registry boundary for the alpha.3 corrective release line. `agent-cli-runtime@0.1.0-alpha.2` is published, but its immutable npm tarball contains stale pre-publish package docs. `agent-cli-runtime@0.1.0-alpha.3` is the corrective pre-alpha release for package consumers. npm registry metadata and GitHub Releases are the source of truth for available versions and dist-tags.
|
|
7
|
+
|
|
8
|
+
This runbook does not create or commit npm credentials and does not configure trusted publishing. Current-head release-candidate run ids, artifact digests, tarball shasums, pack shasums, integrity values, and local temporary paths are recorded outside the npm package under `.release-evidence/` or attached as GitHub Release assets; package docs keep only stable process rules, the alpha.2 stale package-docs incident, the alpha.3 corrective boundary, and the human-gated boundary for registry mutations.
|
|
7
9
|
|
|
8
10
|
## Decision
|
|
9
11
|
|
|
10
|
-
|
|
12
|
+
Current state and future human gate:
|
|
11
13
|
|
|
12
14
|
- Package metadata is ready for an alpha package page: `name`, `version`, `description`, `license`, `type`, `bin`, `main`, `types`, `exports`, `files`, `engines`, `repository`, `homepage`, `bugs`, `keywords`, and `publishConfig.tag` are present and intentional.
|
|
13
15
|
- The package root value API remains `createAgentRuntime` only; public TypeScript types are exposed through the root declarations, not as runtime values.
|
|
14
16
|
- The release-candidate workflow remains artifact-only: it creates and verifies the tarball but does not publish and does not require registry credentials.
|
|
15
|
-
-
|
|
16
|
-
-
|
|
17
|
-
-
|
|
18
|
-
-
|
|
19
|
-
-
|
|
20
|
-
-
|
|
17
|
+
- Corrective package line: `agent-cli-runtime@0.1.0-alpha.3`.
|
|
18
|
+
- Stale-docs incident package: `agent-cli-runtime@0.1.0-alpha.2`.
|
|
19
|
+
- Previous package: `agent-cli-runtime@0.1.0-alpha.1`.
|
|
20
|
+
- Previous GitHub pre-release: `v0.1.0-alpha.1`.
|
|
21
|
+
- `agent-cli-runtime@0.1.0-alpha.0` is deprecated because its immutable package docs shipped stale pre-publish state.
|
|
22
|
+
- Future human-controlled publish path: use the fresh release-candidate workflow for the commit being considered, download all five artifacts, run `npm run release:verify -- --dir <normalized-artifact-dir>`, run `npm run package:docs:check`, run `npm publish --dry-run --ignore-scripts --tag alpha`, and require explicit maintainer authorization before any registry mutation.
|
|
23
|
+
- Current-head evidence rule: trigger a fresh release-candidate workflow for the commit being considered, download all five artifacts, run `npm run release:verify -- --dir <normalized-artifact-dir>`, and record volatile run evidence under `.release-evidence/`.
|
|
24
|
+
- Because this runbook and release report are included in the npm package, do not write current run ids, artifact digests, tarball shasums, integrity values, or pack shasums into package docs.
|
|
25
|
+
- Before any future real publish, confirm the fresh release-candidate workflow head SHA matches the commit being published.
|
|
26
|
+
- After any future real publish, run the manual published package verification workflow and download `agent-cli-runtime-published-verification`; it must pass `npm run published:verify:evidence -- --dir <downloaded-artifact-dir>`.
|
|
21
27
|
- Do not reuse historical workflow runs as publish evidence for a later commit.
|
|
22
28
|
|
|
23
29
|
## Boundaries
|
|
24
30
|
|
|
25
31
|
- Do not add npm tokens, GitHub tokens, registry credential environment variables, or private auth files.
|
|
26
|
-
- Do not configure real npm trusted publishing
|
|
32
|
+
- Do not configure real npm trusted publishing in this release line.
|
|
27
33
|
- Do not add daemon, database, WAL, remote worker, web UI, telemetry, scheduler expansion, or package-root value exports.
|
|
34
|
+
- Do not run `npm publish`, `npm deprecate`, or GitHub Release create/edit commands without explicit maintainer authorization.
|
|
28
35
|
|
|
29
|
-
## Pre-Publish Checks
|
|
36
|
+
## Future Pre-Publish Checks
|
|
30
37
|
|
|
31
|
-
Run from the repository root on a clean
|
|
38
|
+
Run from the repository root on a clean checkout before any future package version is published:
|
|
32
39
|
|
|
33
40
|
```bash
|
|
34
41
|
git status --short
|
|
@@ -38,7 +45,8 @@ npm run lint
|
|
|
38
45
|
npm test
|
|
39
46
|
npm run build
|
|
40
47
|
npm run package:check
|
|
41
|
-
|
|
48
|
+
npm run package:docs:check
|
|
49
|
+
tmp_dir="$(mktemp -d)"
|
|
42
50
|
npm run release:candidate -- --out-dir "$tmp_dir"
|
|
43
51
|
npm run release:verify -- --dir "$tmp_dir"
|
|
44
52
|
npm pack --dry-run
|
|
@@ -48,7 +56,7 @@ node ./dist/cli/main.js doctor --json
|
|
|
48
56
|
git diff --check
|
|
49
57
|
```
|
|
50
58
|
|
|
51
|
-
Before a real publish, also confirm the current branch and evidence target:
|
|
59
|
+
Before a future real publish, also confirm the current branch and evidence target:
|
|
52
60
|
|
|
53
61
|
```bash
|
|
54
62
|
git rev-parse --abbrev-ref HEAD
|
|
@@ -56,7 +64,7 @@ git rev-parse HEAD
|
|
|
56
64
|
git rev-parse origin/main
|
|
57
65
|
gh workflow run release-candidate.yml --ref main
|
|
58
66
|
gh run view <current-release-candidate-run-id> --json headSha,status,conclusion,url,jobs
|
|
59
|
-
npm view agent-cli-runtime
|
|
67
|
+
npm view agent-cli-runtime@<next-version> version --json
|
|
60
68
|
npm dist-tag ls agent-cli-runtime
|
|
61
69
|
```
|
|
62
70
|
|
|
@@ -66,21 +74,19 @@ The dry-run command is the required local npm publish simulation for this stage:
|
|
|
66
74
|
npm publish --dry-run --ignore-scripts --tag alpha
|
|
67
75
|
```
|
|
68
76
|
|
|
69
|
-
The command must report a dry run and must show `tag alpha`. If it reports `latest`,
|
|
70
|
-
|
|
71
|
-
Dry-run stop point: stop after `npm publish --dry-run --ignore-scripts --tag alpha` until a maintainer separately authorizes the true publish and fresh current-head release-candidate evidence has passed.
|
|
77
|
+
The command must report a dry run and must show `tag alpha`. If it reports `latest`, fix the command or metadata before publishing.
|
|
72
78
|
|
|
73
79
|
## Human Confirmation Points
|
|
74
80
|
|
|
75
|
-
Before a real publish, a maintainer must confirm:
|
|
81
|
+
Before a future real publish, a maintainer must confirm:
|
|
76
82
|
|
|
77
83
|
- The version is exactly the intended immutable npm version. A published `name@version` cannot be overwritten.
|
|
78
84
|
- The release-candidate run head SHA matches the commit being published; historical runs are insufficient for later commits.
|
|
79
|
-
- `npm pack --dry-run
|
|
80
|
-
- `.reference/`, `tests/`, fixtures, raw real CLI output, private paths, token-looking values, and repair backups are absent from the packed files.
|
|
85
|
+
- `npm run package:docs:check`, `npm pack --dry-run`, and `npm publish --dry-run --ignore-scripts --tag alpha` show only expected files and release-state wording.
|
|
86
|
+
- `.reference/`, `.release-evidence/`, `tests/`, fixtures, raw real CLI output, private paths, token-looking values, and repair backups are absent from the packed files.
|
|
81
87
|
- `dist/index.js` runtime value exports remain limited to `createAgentRuntime`.
|
|
82
88
|
- `dist/index.d.ts` exposes public types without re-exporting storage/parser/store internals as the package-root contract.
|
|
83
|
-
- The alpha tag is intentional. If
|
|
89
|
+
- The alpha tag is intentional. If there is still no stable version and npm also points `latest` at a pre-alpha, document that exact post-publish state outside packaged docs or in stable package wording that names the registry as authoritative.
|
|
84
90
|
- The npm account/package publishing policy is understood: 2FA or an approved token path is required by npm package settings.
|
|
85
91
|
- The publisher accepts the provenance choice below and has the right npm package permissions.
|
|
86
92
|
|
|
@@ -107,31 +113,31 @@ If npm asks for a second factor, complete the interactive 2FA prompt or use the
|
|
|
107
113
|
Immediately after any real publish:
|
|
108
114
|
|
|
109
115
|
```bash
|
|
110
|
-
npm view agent-cli-runtime@0.1.0-alpha.
|
|
116
|
+
npm view agent-cli-runtime@0.1.0-alpha.3 version dist-tags --json
|
|
111
117
|
npm dist-tag ls agent-cli-runtime
|
|
118
|
+
npm run published:verify -- --out-dir published-verification
|
|
119
|
+
npm run published:verify:evidence -- --dir published-verification
|
|
112
120
|
```
|
|
113
121
|
|
|
114
122
|
Expected result:
|
|
115
123
|
|
|
116
|
-
- `
|
|
117
|
-
-
|
|
124
|
+
- `agent-cli-runtime@0.1.0-alpha.3` is the corrective package line.
|
|
125
|
+
- Registry dist-tags match the maintainer's intended pre-alpha policy.
|
|
126
|
+
- Published verification includes `agent-cli-runtime.packagedDocsVerification.v1` for the npm registry tarball.
|
|
118
127
|
|
|
119
128
|
If the wrong tag is attached but the package version itself is acceptable, fix the tag rather than republishing the same version:
|
|
120
129
|
|
|
121
130
|
```bash
|
|
122
|
-
npm dist-tag add agent-cli-runtime@0.1.0-alpha.
|
|
123
|
-
npm dist-tag rm agent-cli-runtime latest
|
|
131
|
+
npm dist-tag add agent-cli-runtime@0.1.0-alpha.3 alpha
|
|
124
132
|
npm dist-tag ls agent-cli-runtime
|
|
125
133
|
```
|
|
126
134
|
|
|
127
|
-
Only remove `latest` after confirming it points to the accidental alpha version.
|
|
128
|
-
|
|
129
135
|
## 2FA, Token, And Provenance Strategy
|
|
130
136
|
|
|
131
|
-
|
|
137
|
+
Current decision:
|
|
132
138
|
|
|
133
|
-
- Preferred future automated path: npm trusted publishing from a dedicated GitHub Actions publish workflow with a human approval gate. This is not configured
|
|
134
|
-
- Preferred
|
|
139
|
+
- Preferred future automated path: npm trusted publishing from a dedicated GitHub Actions publish workflow with a human approval gate. This is not configured here.
|
|
140
|
+
- Preferred manual alpha path: interactive local `npm publish --tag alpha` by a maintainer with 2FA enabled and no committed tokens.
|
|
135
141
|
- Avoid long-lived npm automation tokens for this package unless trusted publishing cannot be used and a maintainer explicitly accepts the rotation, scope, and audit trade-off.
|
|
136
142
|
- Do not add registry credential environment variables to the existing `ci.yml` or `release-candidate.yml` workflows.
|
|
137
143
|
|
|
@@ -160,15 +166,15 @@ Useful official references:
|
|
|
160
166
|
|
|
161
167
|
If dry-run fails:
|
|
162
168
|
|
|
163
|
-
- Stop
|
|
164
|
-
- Fix metadata, build output, package boundary, or auth state.
|
|
169
|
+
- Stop before any registry mutation.
|
|
170
|
+
- Fix metadata, build output, package boundary, package docs, or auth state.
|
|
165
171
|
- Rerun the full pre-publish checks.
|
|
166
172
|
|
|
167
173
|
If real publish fails before package creation:
|
|
168
174
|
|
|
169
175
|
- Capture the redacted error class only.
|
|
170
176
|
- Do not commit npm debug logs if they contain local paths, auth state, or registry session details.
|
|
171
|
-
- Re-run `npm view agent-cli-runtime@0.1.0-alpha.
|
|
177
|
+
- Re-run `npm view agent-cli-runtime@0.1.0-alpha.3 version --json` before retrying to confirm the version was not created.
|
|
172
178
|
|
|
173
179
|
If real publish succeeds but post-publish checks fail:
|
|
174
180
|
|
|
@@ -178,13 +184,13 @@ If real publish succeeds but post-publish checks fail:
|
|
|
178
184
|
- If the package is unsafe and still eligible under npm policy, consider unpublish only as an emergency path:
|
|
179
185
|
|
|
180
186
|
```bash
|
|
181
|
-
npm unpublish agent-cli-runtime@0.1.0-alpha.
|
|
187
|
+
npm unpublish agent-cli-runtime@0.1.0-alpha.3
|
|
182
188
|
```
|
|
183
189
|
|
|
184
190
|
Unpublish has strict policy limits and cannot make the same `name@version` reusable. If unpublish is not allowed or would break consumers, prefer deprecation:
|
|
185
191
|
|
|
186
192
|
```bash
|
|
187
|
-
npm deprecate agent-cli-runtime@0.1.0-alpha.
|
|
193
|
+
npm deprecate agent-cli-runtime@0.1.0-alpha.3 "Do not use this alpha; upgrade to a later pre-release."
|
|
188
194
|
```
|
|
189
195
|
|
|
190
196
|
## Rollback Boundary
|
|
@@ -196,4 +202,4 @@ Rollback means one of these actions:
|
|
|
196
202
|
- Unpublish only when npm policy allows it and a maintainer accepts the registry impact.
|
|
197
203
|
- Publish a new corrected pre-release version.
|
|
198
204
|
|
|
199
|
-
Rollback does not mean overwriting `agent-cli-runtime@0.1.0-alpha.1`; npm does not permit replacing an already published package version.
|
|
205
|
+
Rollback does not mean overwriting `agent-cli-runtime@0.1.0-alpha.2` or `agent-cli-runtime@0.1.0-alpha.3`; npm does not permit replacing an already published package version.
|