Repository navigation
Commit 56734ad
authored
docs: make the catalog refresh a release step, not an afterthought (#204)
* docs: make the catalog refresh a release step, not an afterthought
The 0.1.4 release exposed a gap in the runbook rather than a one-off
slip. `docs/RELEASING.md` describes packing the catalog `.zip` asset but
never says to refresh the community-catalog entry that points at it, and
nothing in the pipeline does it automatically — the entry is data in
another repository, pinned to a specific release asset.
The result: adrkit's entry sat at 0.1.2 through both 0.1.3 and 0.1.4,
still advertising `speckit_version: >=0.13.0,<0.16.0` — a bound that by
then refused to install on any current Spec Kit. Catalog users were
getting a two-versions-old artifact whose manifest rejected their
toolchain, while npm looked perfectly healthy. The npm publish looked
like the whole release and was not.
The mechanism also changed under us. Upstream's publishing guide now
states plainly that pull requests against `catalog.community.json` are
not accepted, and routes version bumps through the Extension Submission
issue template. The original 0.1.0 listing did land as a PR (#3947), so
the obvious move is now the wrong one and worth naming explicitly.
- `docs/RELEASING.md` gains the refresh step in the adapter release
section: file the issue (not a PR), wait for the asset to resolve
because maintainers verify the URL, and change only `version`,
`download_url`, `requires.speckit_version`, and `updated_at`.
- ADR-0019 action item 5 records that this is a standing per-release
obligation rather than the completed task it read as, and links the
0.1.4 refresh (github/spec-kit#4571).
- The `[spec-kit-0.1.4]` CHANGELOG heading moves to 2026-09-13, the date
the tag and release actually landed. The ADR and evidence-index dates
are unchanged and correct — they date the re-verification, which did
happen on 2026-09-12.
Documentation only. Schema, `packages/ci`, and every shipped artifact
untouched; `check:changelog`, `check:doc-pins`, `check:deps` and
`adr lint` (37 records, 0 errors) pass.
Claude-Session: https://claude.ai/code/session_01UHoVZxZp529qJg1mgwJqxZ
Signed-off-by: Mark Beacom <[email protected]>
* docs: correct the catalog history, scope the field list, stop calling a filing a refresh
Review feedback on #204, all four points valid, and the factual one
changes the story rather than just a detail.
`github/spec-kit#3947` listed **0.1.2**, not 0.1.0 — and its body says
"submitted by @mbeacom via issue #3942". Issue #3942 is ours, dated
2026-08-03 and labeled `extension-submission`; the pull request was the
maintainer applying it the same day. So the contributor path was
*always* the issue template. The previous text said the original listing
"did land as a PR" and that "that path has since been closed", which
implied a process change that never happened and invited exactly the
pull request upstream refuses. Corrected to name both, and to say
plainly that the pull request is the maintainer's step, not ours.
That also dates ADR-0019's action item 5, which said "landed 2026-08-25";
the issue and the pull request are both 2026-08-03, corroborated by the
catalog entry's own `created_at`. Corrected, with the prior claim noted
rather than silently overwritten.
The remaining three:
- The `curl` check hardcoded `spec-kit-v0.1.4`. In a step whose whole
point is that it recurs, copying it for 0.1.5 would validate the *old*
asset and return 200 — confirming the wrong thing while looking like
verification. Now binds `tag` once and interpolates it.
- "Change only `version`, `download_url`, `requires.speckit_version`,
and `updated_at`" was absolute where upstream asks for "any other
changed fields". A future release that alters the description,
`category`, `effect`, the command or hook counts, or `requires.tools`
would have followed that instruction into a stale entry the version
number does not reveal. Reframed as the common case, with the rule
being to compare the proposed entry against `extension.yml`.
- ADR-0019 called #4571 a completed refresh. It is an open submission:
the entry is still 0.1.2, and `specify extension search` keeps serving
it until a maintainer applies the update. Filing is not refreshing,
and recording it as done would have hidden a live staleness behind a
checked box — the same failure this PR exists to fix. Now recorded as
submitted and open, with the refresh to be recorded when it lands.
Documentation only. `check:changelog`, `check:doc-pins`, `check:deps`,
and `adr lint` (37 records, 0 errors) pass.
Claude-Session: https://claude.ai/code/session_01UHoVZxZp529qJg1mgwJqxZ
Signed-off-by: Mark Beacom <[email protected]>
---------
Signed-off-by: Mark Beacom <[email protected]>1 parent c5cae1e commit 56734ad
3 files changed
Lines changed: 42 additions & 2 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
9 | 9 | | |
10 | 10 | | |
11 | 11 | | |
12 | | - | |
| 12 | + | |
13 | 13 | | |
14 | 14 | | |
15 | 15 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
202 | 202 | | |
203 | 203 | | |
204 | 204 | | |
| 205 | + | |
| 206 | + | |
| 207 | + | |
| 208 | + | |
| 209 | + | |
| 210 | + | |
| 211 | + | |
| 212 | + | |
| 213 | + | |
| 214 | + | |
| 215 | + | |
| 216 | + | |
| 217 | + | |
| 218 | + | |
| 219 | + | |
| 220 | + | |
| 221 | + | |
| 222 | + | |
| 223 | + | |
| 224 | + | |
| 225 | + | |
| 226 | + | |
| 227 | + | |
| 228 | + | |
| 229 | + | |
| 230 | + | |
| 231 | + | |
| 232 | + | |
| 233 | + | |
| 234 | + | |
| 235 | + | |
| 236 | + | |
| 237 | + | |
| 238 | + | |
| 239 | + | |
| 240 | + | |
| 241 | + | |
| 242 | + | |
| 243 | + | |
| 244 | + | |
205 | 245 | | |
206 | 246 | | |
207 | 247 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
245 | 245 | | |
246 | 246 | | |
247 | 247 | | |
248 | | - | |
| 248 | + | |
249 | 249 | | |
250 | 250 | | |
251 | 251 | | |
| |||
0 commit comments