14d0238cf5
Consolidate all pre-rename release notes (the retired get-shit-done-cc / get-shit-done-redux lineage, 1.0.0 -> 1.50.0-canary.1) into one condensed, read-only archive so the legacy 1.x version numbers no longer collide with the current @opengsd/gsd-core line. - Add docs/RELEASE-NOTES-LEGACY.md: rename banner, master version-index table, condensed per-version sections (1.42.3 -> 1.0.0), and a separate pre-release & canary builds section. Stale install commands stripped. - Trim CHANGELOG.md to the current @opengsd/gsd-core line only; replace the Legacy Release History block with a pointer to the archive and drop the orphaned numbered legacy reference-link definitions. - Remove the 10 standalone docs/RELEASE-v*.md files. - Repoint docs/CANARY.md and docs/FEATURES.md links to the new archive. Closes #658 Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
67 lines
3.3 KiB
Markdown
67 lines
3.3 KiB
Markdown
# Canary Stream
|
|
|
|
The **canary** dist-tag is GSD's earliest preview channel. It exists so contributors and willing early adopters can exercise in-flight features against the long-lived `dev` integration branch before they have any expectation of stability.
|
|
|
|
## Stream policy
|
|
|
|
GSD ships through three npm dist-tags, each fed by exactly one git branch. **Streams do not mix.**
|
|
|
|
| Branch | dist-tag | Audience | Stability |
|
|
|---|---|---|---|
|
|
| `dev` | `canary` | Contributors, willing early adopters | Best-effort. May regress between cuts. Roll-forward only. |
|
|
| `main` | `next` | Maintainers, RC testers | Release-candidate quality. Bug-bar enforced. |
|
|
| `main` | `latest` | Everyone else | Production stable. The default `npm install` target. |
|
|
|
|
`dev` is the integration branch for in-flight feature work (typically multi-PR vertical slices like the MVP/TDD/UAT track in 1.50.0). When the dev work stabilizes, it promotes to `main` as an RC train (`vX.Y.Z-rc.N` published to `next`), and after the RC train bakes, the same train promotes again to `latest`.
|
|
|
|
A canary build NEVER becomes a `next` build directly, and a `next` build NEVER becomes a `latest` build directly — every promotion goes through a fresh tag and a fresh release.
|
|
|
|
## Installing canary
|
|
|
|
```bash
|
|
# One-off invocation (npx)
|
|
npx @opengsd/gsd-core@canary
|
|
|
|
# Pin to the canary dist-tag globally
|
|
npm install -g @opengsd/gsd-core@canary
|
|
|
|
# Pin to an exact canary version
|
|
npm install -g @opengsd/gsd-core@1.50.0-canary.1
|
|
```
|
|
|
|
The CC installer's defensive purge rewrites stale config blocks left by older GSD versions, so reinstalling on top of an existing project is safe.
|
|
|
|
## When to install canary
|
|
|
|
✅ **Do** install canary when you want to:
|
|
- Exercise in-flight planning/execution/verification features early and report findings
|
|
- Validate a fix you've contributed to `dev` is reachable end-to-end
|
|
- Help shake out canary-bake items (rough edges that won't ship to `next` until resolved)
|
|
|
|
❌ **Do NOT** install canary on:
|
|
- Production projects you depend on for delivery
|
|
- A machine where rolling back means recreating GSD state (use a profile or a workspace instead)
|
|
- A demo or onboarding setup — pin to `@latest` so audiences see the stable surface
|
|
|
|
## Rolling back from canary
|
|
|
|
```bash
|
|
# Back to the current stable
|
|
npm install -g @opengsd/gsd-core@latest
|
|
|
|
# Or to the next/RC train
|
|
npm install -g @opengsd/gsd-core@next
|
|
```
|
|
|
|
If you have a local project that interacted with canary-only features (for instance, an MVP-mode phase planned by 1.50.0-canary), the planner artifacts in `.planning/` remain valid — older GSD versions will just ignore the `**Mode:** mvp` field on phases.
|
|
|
|
## Reporting issues against canary
|
|
|
|
File against the [issue tracker](https://github.com/open-gsd/gsd-core/issues) with the `bug` template. Include the exact canary version (`gsd-core --version` reports it) so triage can route the report back into the `dev` stream rather than the stable stream.
|
|
|
|
## Where to look next
|
|
|
|
- Active canary release notes: [`v1.50.0-canary.1` (now in the legacy release-notes archive)](RELEASE-NOTES-LEGACY.md)
|
|
- Stable release notes: [`CHANGELOG.md`](../CHANGELOG.md)
|
|
- Stream architecture rationale: discussed across [#2727](https://github.com/open-gsd/gsd-core/issues/2727), [#2773](https://github.com/open-gsd/gsd-core/issues/2773) (codex schema-break and the resulting promotion bottleneck that motivated explicit stream isolation)
|