22
33This package publishes to npm as ` agent-control ` .
44
5+ ## Release policy
6+
7+ - TypeScript SDK releases are independent from server/monorepo version tags.
8+ - Releases are commit-driven via ` semantic-release ` .
9+ - Expected release-triggering commit scopes use ` sdk-ts ` :
10+ - ` feat(sdk-ts): ... ` -> minor bump
11+ - ` fix(sdk-ts): ... ` , ` perf(sdk-ts): ... ` , ` refactor(sdk-ts): ... ` , ` chore(sdk-ts): ... ` -> patch bump
12+ - ` BREAKING CHANGE ` or ` ! ` -> major bump
13+
514## One-time setup
615
7161 . Ensure npm ownership for ` agent-control ` is configured.
8172 . Add repository secret ` NPM_TOKEN ` with publish permission.
9- 3 . Ensure GitHub Actions has ` id-token: write ` permission for provenance.
18+ 3 . Ensure workflow ` .github/workflows/release-sdk-ts.yml ` has:
19+ - ` contents: write ` for release commit/tag
20+ - ` id-token: write ` for npm provenance
1021
11- ## Pre-release checklist
22+ ## Pre-release checks
1223
1324Run from repo root:
1425
@@ -21,36 +32,34 @@ This validates:
2132- Generated client is current
2233- Lint, typecheck, test, and build all pass
2334
24- ## Local package dry run
35+ ## Local semantic-release preview
2536
26- Run from repo root :
37+ Run from ` sdks/typescript ` :
2738
2839``` bash
29- make sdk-ts-publish- dry-run
40+ pnpm run release: dry-run
3041```
3142
32- This runs the publish gate checks and then executes ` npm publish --dry-run ` .
43+ This previews the next semantic version and release notes without publishing .
3344
3445## GitHub Actions release flow
3546
36- Use workflow ` .github/workflows/release-sdk-ts.yml ` :
47+ Workflow: ` .github/workflows/release-sdk-ts.yml `
3748
38- 1 . Trigger manually with ` dry_run=true ` first .
39- 2 . Confirm all checks and packaging output are correct .
40- 3 . Trigger again with ` dry_run=false ` to publish .
49+ - Automatic publish: runs on ` push ` to ` main ` .
50+ - Manual preview: ` workflow_dispatch ` with ` dry_run=true ` .
51+ - Manual publish: ` workflow_dispatch ` with ` dry_run=false ` .
4152
42- The publish run performs:
43- - ` make sdk-ts-generate-check ` (this generates OpenAPI from server code, then checks SDK/overlay drift)
44- - ` make sdk-ts-lint `
45- - ` make sdk-ts-typecheck `
46- - ` make sdk-ts-test `
47- - ` make sdk-ts-build `
48- - ` npm publish --provenance `
53+ Release job performs:
54+ - ` make sdk-ts-release-check `
55+ - ` semantic-release ` (updates ` package.json ` + ` CHANGELOG.md ` , creates Git tag/release, publishes to npm)
4956
5057## Post-publish verification
5158
52- 1 . Install from npm in a clean temp project:
59+ 1 . Confirm npm version/dist-tag:
60+ - ` npm view agent-control version dist-tags --json `
61+ 2 . Install from npm in a clean temp project:
5362 - ` npm i agent-control `
54- 2 . Confirm import works:
63+ 3 . Confirm import works:
5564 - ` import { AgentControlClient } from "agent-control"; `
56- 3 . Verify package metadata on npm and GitHub release notes .
65+ 4 . Verify GitHub release/tag and changelog update .
0 commit comments