Commit f6cb68e
Fix stale comments in release-pipeline scaffolding
Three documentation-drift findings from Copilot reviewer on PR #160,
all in code introduced earlier in the same PR:
- scripts/verify-changelog.ts: header comment claimed the TypeScript
client had no per-tag GitHub Actions workflow and verify-changelog was
the only enforcement. That was true mid-PR; the final PR adds
publish-typescript.yml (GHA -> ADO bridge) plus verify steps in the
ADO pipeline.yml itself. Replace the comment with the actual
defense-in-depth picture: every per-tag workflow + the ADO pipeline +
ci.yml all re-run this script.
- .github/workflows/publish-spec.yml: comment said a re-pushed tag
cancels the in-flight run, but cancel-in-progress is set to false
precisely so we don't abort a half-finished GitHub Release upload.
Rewrite the comment to explain the actual queueing behaviour and why
it's deliberate.
- scripts/read-protocol-versions.ts: JSDoc described a hard-coded
fallback when the registry source file isn't in the project. The
implementation throws instead. Rewrite the JSDoc to match: throws on
missing source file, missing constants, or order-invariant
violations, and callers building a partial ts-morph project must
include types/version/registry.ts.
No behaviour change. typecheck, lint, verify:release-metadata, and
verify:changelog all still green; YAML still parses.
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>1 parent 8e1f18c commit f6cb68e
3 files changed
Lines changed: 15 additions & 9 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
20 | 20 | | |
21 | 21 | | |
22 | 22 | | |
23 | | - | |
24 | | - | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
25 | 27 | | |
26 | 28 | | |
27 | 29 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
26 | 26 | | |
27 | 27 | | |
28 | 28 | | |
29 | | - | |
30 | | - | |
31 | | - | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
32 | 33 | | |
33 | 34 | | |
34 | 35 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
9 | 9 | | |
10 | 10 | | |
11 | 11 | | |
12 | | - | |
13 | | - | |
14 | | - | |
15 | | - | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
16 | 19 | | |
17 | 20 | | |
18 | 21 | | |
| |||
0 commit comments