Skip to content

Commit cd0e025

Browse files
committed
docs: tighten repo metadata and release narrative
1 parent 795f841 commit cd0e025

3 files changed

Lines changed: 69 additions & 4 deletions

File tree

.github/workflows/publish.yml

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,16 @@ jobs:
100100
env:
101101
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
102102
run: |
103-
gh release create "${{ steps.release.outputs.tag }}" \
104-
--title "@spencer-kit/coder-studio ${{ steps.release.outputs.version }}" \
105-
--generate-notes \
106-
--verify-tag
103+
release_notes_file="docs/promotion/releases/${{ steps.release.outputs.tag }}.md"
104+
105+
if [ -f "${release_notes_file}" ]; then
106+
gh release create "${{ steps.release.outputs.tag }}" \
107+
--title "@spencer-kit/coder-studio ${{ steps.release.outputs.version }}" \
108+
--notes-file "${release_notes_file}" \
109+
--verify-tag
110+
else
111+
gh release create "${{ steps.release.outputs.tag }}" \
112+
--title "@spencer-kit/coder-studio ${{ steps.release.outputs.version }}" \
113+
--generate-notes \
114+
--verify-tag
115+
fi

docs/promotion/releases/README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Release Narratives
2+
3+
These files are the human-facing release stories for Coder Studio.
4+
5+
They are not a replacement for `packages/cli/CHANGELOG.md`. The changelog remains the canonical package history, while release narratives explain why a release matters, who benefits, and what changed in product terms.
6+
7+
## When to add one
8+
9+
Add a release narrative when a version is published to GitHub and npm, especially when the raw changeset summary is too terse for first-time evaluators.
10+
11+
## Suggested structure
12+
13+
1. Why this release matters
14+
2. What changed in product language
15+
3. Who benefits most
16+
4. Install or upgrade command
17+
5. Full changelog comparison link
18+
19+
## Current releases
20+
21+
- [v0.3.5](v0.3.5.md)

docs/promotion/releases/v0.3.5.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Coder Studio v0.3.5
2+
3+
## Why this patch matters
4+
5+
Coder Studio is most valuable when you let Claude Code or Codex run for a while, step away, and return later from another device. That workflow breaks down fast if a silent websocket disconnect causes terminal output to disappear.
6+
7+
`v0.3.5` is a reliability patch focused on that gap. It strengthens terminal recovery so buffered PTY output is replayed after silent disconnects, with better probe-based recovery and keepalive handling.
8+
9+
In practice, this release means:
10+
11+
- less missing terminal output after short network interruptions
12+
- more confidence when leaving long-running AI tasks unattended
13+
- better continuity when checking progress from desktop, tablet, or phone
14+
15+
## Included in v0.3.5
16+
17+
- fix terminal websocket recovery so buffered PTY output is replayed after silent disconnects
18+
- improve probe-based recovery and keepalive handling for long-running terminal sessions
19+
20+
## Who benefits most
21+
22+
- developers running long Claude Code or Codex tasks
23+
- users checking workspace progress from another device
24+
- anyone relying on Coder Studio as a persistent browser-based AI coding workspace
25+
26+
## Install or upgrade
27+
28+
```bash
29+
npm install -g @spencer-kit/coder-studio
30+
coder-studio open
31+
```
32+
33+
## Full changelog
34+
35+
- [Compare `v0.3.4...v0.3.5`](https://github.com/spencerkit/coder-studio/compare/v0.3.4...v0.3.5)

0 commit comments

Comments
 (0)