Skip to content

Commit 792132b

Browse files
authored
docs(release): add changelog and stable release history (#189)
1 parent 7734787 commit 792132b

2 files changed

Lines changed: 241 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -118,6 +118,32 @@ CLI input
118118
- For CLI, config, or pager work: make sure the relevant source invocation still works (`diff`, `show`, `patch`, or `pager`).
119119
- Preserve current interaction model unless the user asks to change it explicitly.
120120

121+
## releases
122+
123+
- Maintain the top-level `CHANGELOG.md` as the source of truth for user-visible changes.
124+
- Keep upcoming work under `## [Unreleased]` with these subsections:
125+
- `### Added`
126+
- `### Changed`
127+
- `### Fixed`
128+
- Append to existing subsections instead of creating duplicates.
129+
- When cutting a release, move the relevant unreleased entries into a new immutable version section and start a fresh `## [Unreleased]` section.
130+
- Use the released changelog section as the starting point for the GitHub release body.
131+
- GitHub releases should follow this format:
132+
133+
```md
134+
## What's Changed
135+
136+
- <change title> by @<author> in <PR URL>
137+
- ...
138+
139+
**Full Changelog**: https://github.com/modem-dev/hunk/compare/<previous-tag>...<new-tag>
140+
```
141+
142+
- Do not rely blindly on autogenerated GitHub release notes. After publishing, verify the release body and edit it if needed.
143+
- Prefer `gh release create/edit --notes-file` for multi-line release notes so the exact body is reviewed before posting.
144+
- For patch releases and backports, list only changes actually present between the previous tag and the new tag on that release branch.
145+
- Prefer concise, user-visible entries over internal refactors unless the refactor changes user-visible behavior.
146+
121147
## repo notes
122148

123149
- Local review artifacts are ignored on purpose. Leave them alone unless the user explicitly wants them updated, and do not commit them.

CHANGELOG.md

Lines changed: 215 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,215 @@
1+
# Changelog
2+
3+
All notable user-visible changes to Hunk are documented in this file.
4+
5+
## [Unreleased]
6+
7+
### Added
8+
9+
### Changed
10+
11+
### Fixed
12+
13+
## [0.9.1] - 2026-04-10
14+
15+
### Fixed
16+
17+
- Preserved viewport position when switching layouts ([#185](https://github.com/modem-dev/hunk/pull/185)).
18+
- Skipped binary file contents in reviews while keeping binary files visible in the review stream with a `Binary file skipped` placeholder ([#187](https://github.com/modem-dev/hunk/pull/187)).
19+
20+
## [0.9.0] - 2026-04-08
21+
22+
### Added
23+
24+
- Added `hunk session review --json` for full live-session exports ([#160](https://github.com/modem-dev/hunk/pull/160)).
25+
- Added horizontal code-column scrolling in review mode ([#171](https://github.com/modem-dev/hunk/pull/171)).
26+
- Added batch apply support for live session comments in agent review flows ([#179](https://github.com/modem-dev/hunk/pull/179)).
27+
28+
### Changed
29+
30+
- Pinned the current file header while scrolling the review pane ([#141](https://github.com/modem-dev/hunk/pull/141)).
31+
- Made session comment focus opt-in instead of forcing comment focus by default ([#163](https://github.com/modem-dev/hunk/pull/163)).
32+
- Synced active hunks to mouse scrolling and prefetched diff highlighting for smoother navigation ([#172](https://github.com/modem-dev/hunk/pull/172)).
33+
- Hid zero-value sidebar file stats to reduce visual noise ([#174](https://github.com/modem-dev/hunk/pull/174)).
34+
- Updated in-app controls help ([#175](https://github.com/modem-dev/hunk/pull/175)).
35+
- Sped up syntax-highlight row building in large diffs ([#177](https://github.com/modem-dev/hunk/pull/177)).
36+
37+
### Fixed
38+
39+
- Reported the packaged version correctly in installed builds ([#153](https://github.com/modem-dev/hunk/pull/153)).
40+
- Fixed stale syntax highlights after reloads ([#146](https://github.com/modem-dev/hunk/pull/146)).
41+
- Fixed diff pane header popping while scrolling ([#159](https://github.com/modem-dev/hunk/pull/159)).
42+
- Avoided failures on untracked directory symlinks ([#169](https://github.com/modem-dev/hunk/pull/169)).
43+
- Aligned top-menu dropdowns correctly ([#176](https://github.com/modem-dev/hunk/pull/176)).
44+
- Restored live escape handling in PTY flows ([#173](https://github.com/modem-dev/hunk/pull/173)).
45+
- Kept viewport-follow selection from jumping unexpectedly ([#181](https://github.com/modem-dev/hunk/pull/181)).
46+
- Refreshed stale daemons after upgrades ([#178](https://github.com/modem-dev/hunk/pull/178)).
47+
- Rejected incompatible live session registrations more clearly ([#180](https://github.com/modem-dev/hunk/pull/180)).
48+
- Versioned daemon compatibility separately from other MCP behavior ([#183](https://github.com/modem-dev/hunk/pull/183)).
49+
50+
## [0.8.1] - 2026-03-30
51+
52+
### Fixed
53+
54+
- Enabled `j` and `k` step scrolling in normal mode ([#131](https://github.com/modem-dev/hunk/pull/131)).
55+
- Aligned inline note rendering more cleanly beside diffs ([#137](https://github.com/modem-dev/hunk/pull/137)).
56+
57+
## [0.8.0] - 2026-03-29
58+
59+
### Added
60+
61+
- Added file state indicators to the sidebar ([#128](https://github.com/modem-dev/hunk/pull/128)).
62+
- Added comment-to-comment navigation in review mode ([#126](https://github.com/modem-dev/hunk/pull/126)).
63+
- Included TTY and tmux pane metadata in session lists ([#90](https://github.com/modem-dev/hunk/pull/90)).
64+
- Added worktree-based session path targeting for session workflows ([#118](https://github.com/modem-dev/hunk/pull/118)).
65+
66+
### Changed
67+
68+
- Included untracked files in working-tree diff reviews by default ([#123](https://github.com/modem-dev/hunk/pull/123)).
69+
- Surfaced a transient startup update notice ([#127](https://github.com/modem-dev/hunk/pull/127)).
70+
- Refined top-level CLI help text and files/filter focus copy ([#129](https://github.com/modem-dev/hunk/pull/129), [#121](https://github.com/modem-dev/hunk/pull/121)).
71+
72+
### Fixed
73+
74+
- Fixed keyboard help dialog row overlap ([#122](https://github.com/modem-dev/hunk/pull/122)).
75+
- Fixed scrollbar click-drag behavior on large diffs ([#120](https://github.com/modem-dev/hunk/pull/120)).
76+
77+
## [0.7.0] - 2026-03-25
78+
79+
### Added
80+
81+
- Grouped sidebar files by folder for easier navigation in large reviews ([#99](https://github.com/modem-dev/hunk/pull/99)).
82+
- Added `Ctrl+D`, `Ctrl+U`, and `Shift+Space` navigation shortcuts ([#102](https://github.com/modem-dev/hunk/pull/102)).
83+
- Added an auto-hiding vertical scrollbar to the diff pane ([#93](https://github.com/modem-dev/hunk/pull/93)).
84+
- Added Linux arm64 prebuilt package release support ([#107](https://github.com/modem-dev/hunk/pull/107)).
85+
86+
### Fixed
87+
88+
- Prevented scroll snapback when using `Space`, `PageUp`, and `PageDown` ([#105](https://github.com/modem-dev/hunk/pull/105)).
89+
- Normalized Git patch prefixes for parser compatibility ([#106](https://github.com/modem-dev/hunk/pull/106)).
90+
- Kept selected hunks fully visible when they fit in the viewport ([#108](https://github.com/modem-dev/hunk/pull/108)).
91+
- Fixed wrap-toggle redraws while preserving the viewport anchor ([#110](https://github.com/modem-dev/hunk/pull/110)).
92+
93+
## [0.6.1] - 2026-03-24
94+
95+
### Added
96+
97+
- Added watch mode for reloadable reviews ([#91](https://github.com/modem-dev/hunk/pull/91)).
98+
99+
### Changed
100+
101+
- Fit menu dropdowns to their contents ([#92](https://github.com/modem-dev/hunk/pull/92)).
102+
103+
### Fixed
104+
105+
- Shut down idle session daemons more reliably ([#96](https://github.com/modem-dev/hunk/pull/96)).
106+
- Coordinated singleton daemon launches to avoid duplicate background processes ([#97](https://github.com/modem-dev/hunk/pull/97)).
107+
- Exited the daemon process cleanly after shutdown ([#98](https://github.com/modem-dev/hunk/pull/98)).
108+
109+
## [0.6.0] - 2026-03-23
110+
111+
### Added
112+
113+
- Added a reload shortcut for the current diff ([#83](https://github.com/modem-dev/hunk/pull/83)).
114+
115+
### Changed
116+
117+
- Optimized large split review streams for faster rendering on big changesets ([#76](https://github.com/modem-dev/hunk/pull/76)).
118+
- Replaced footer hints with a keyboard help modal ([#88](https://github.com/modem-dev/hunk/pull/88)).
119+
120+
### Fixed
121+
122+
- Restored daemon autostart for prebuilt npm binaries ([#84](https://github.com/modem-dev/hunk/pull/84)).
123+
- Detected `$bunfs` virtual paths correctly when autostarting daemons from Bun binaries ([#86](https://github.com/modem-dev/hunk/pull/86)).
124+
- Published prerelease tags to npm under the `beta` dist-tag ([#87](https://github.com/modem-dev/hunk/pull/87)).
125+
126+
## [0.5.1] - 2026-03-23
127+
128+
### Fixed
129+
130+
- Improved friendly Git command errors during CLI failures ([#75](https://github.com/modem-dev/hunk/pull/75)).
131+
132+
## [0.5.0] - 2026-03-22
133+
134+
### Added
135+
136+
- Added inline agent notes across the review stream, including side-aware range guides ([#69](https://github.com/modem-dev/hunk/pull/69), [#62](https://github.com/modem-dev/hunk/pull/62)).
137+
- Added a session control CLI and a session reload command for live review workflows ([#50](https://github.com/modem-dev/hunk/pull/50), [#63](https://github.com/modem-dev/hunk/pull/63)).
138+
- Added live session comment lifecycle support and expanded the MCP tool surface ([#53](https://github.com/modem-dev/hunk/pull/53), [#39](https://github.com/modem-dev/hunk/pull/39)).
139+
- Added curated Hunk demo examples ([#34](https://github.com/modem-dev/hunk/pull/34)).
140+
141+
### Changed
142+
143+
- Made Graphite the default theme ([#57](https://github.com/modem-dev/hunk/pull/57)).
144+
- Switched review rendering and scroll math to an explicit review row plan for more consistent navigation ([#64](https://github.com/modem-dev/hunk/pull/64), [#67](https://github.com/modem-dev/hunk/pull/67)).
145+
146+
### Fixed
147+
148+
- Hardened MCP daemon lifecycle handling and kept the daemon loopback-only by default ([#36](https://github.com/modem-dev/hunk/pull/36), [#46](https://github.com/modem-dev/hunk/pull/46)).
149+
- Refreshed stale MCP daemons when using the session CLI ([#55](https://github.com/modem-dev/hunk/pull/55)).
150+
- Let the sidebar shortcut force the files pane open ([#56](https://github.com/modem-dev/hunk/pull/56)).
151+
152+
## [0.4.0] - 2026-03-22
153+
154+
### Added
155+
156+
- Auto-started the MCP daemon when needed for live sessions ([#29](https://github.com/modem-dev/hunk/pull/29)).
157+
- Added arrow-key line-by-line scrolling ([#30](https://github.com/modem-dev/hunk/pull/30)).
158+
159+
## [0.3.0] - 2026-03-22
160+
161+
### Added
162+
163+
- Added prebuilt npm binary packaging and automated npm releases, including beta tag support ([#12](https://github.com/modem-dev/hunk/pull/12), [#14](https://github.com/modem-dev/hunk/pull/14), [#15](https://github.com/modem-dev/hunk/pull/15)).
164+
- Added a top-level `hunk --version` command ([#19](https://github.com/modem-dev/hunk/pull/19)).
165+
- Added the experimental MCP daemon for live Hunk sessions ([#22](https://github.com/modem-dev/hunk/pull/22)).
166+
167+
### Changed
168+
169+
- Always showed the diff rail while dimming inactive hunks ([#16](https://github.com/modem-dev/hunk/pull/16)).
170+
- Decoupled sidebar visibility from layout toggles ([#18](https://github.com/modem-dev/hunk/pull/18)).
171+
- Stopped auto-saving view preferences to config files ([#13](https://github.com/modem-dev/hunk/pull/13)).
172+
173+
### Fixed
174+
175+
- Used a supported Intel macOS runner for prebuilt release builds ([#17](https://github.com/modem-dev/hunk/pull/17)).
176+
- Preserved executable permissions for prebuilt binaries after installation.
177+
178+
## [0.2.0] - 2026-03-20
179+
180+
### Fixed
181+
182+
- Fixed npm installs by bundling Bun in published packages ([#11](https://github.com/modem-dev/hunk/pull/11)).
183+
184+
## [0.1.0] - 2026-03-20
185+
186+
### Added
187+
188+
- Initial Hunk release with split and stack terminal diff views built around a single multi-file review stream.
189+
- Added git-style `diff` and `show` commands plus a general Git pager wrapper for drop-in review workflows.
190+
- Added persistent Hunk view preferences across sessions ([#7](https://github.com/modem-dev/hunk/pull/7)).
191+
- Added agent-note anchored review flows, responsive layouts, and display toggles for line numbers, wrapping, and hunk metadata.
192+
193+
### Changed
194+
195+
- Simplified the review chrome around a menu bar, lighter borders, and diff-focused headers.
196+
- Improved startup and large-review performance with windowed diff sections and deferred syntax highlighting.
197+
198+
### Fixed
199+
200+
- Stabilized diff repainting, active-hunk scrolling, syntax highlighting, pager stdin patch handling, and terminal cleanup on exit.
201+
202+
[Unreleased]: https://github.com/modem-dev/hunk/compare/v0.9.1...HEAD
203+
[0.9.1]: https://github.com/modem-dev/hunk/compare/v0.9.0...v0.9.1
204+
[0.9.0]: https://github.com/modem-dev/hunk/compare/v0.8.1...v0.9.0
205+
[0.8.1]: https://github.com/modem-dev/hunk/compare/v0.8.0...v0.8.1
206+
[0.8.0]: https://github.com/modem-dev/hunk/compare/v0.7.0...v0.8.0
207+
[0.7.0]: https://github.com/modem-dev/hunk/compare/v0.6.1...v0.7.0
208+
[0.6.1]: https://github.com/modem-dev/hunk/compare/v0.6.0...v0.6.1
209+
[0.6.0]: https://github.com/modem-dev/hunk/compare/v0.5.1...v0.6.0
210+
[0.5.1]: https://github.com/modem-dev/hunk/compare/v0.5.0...v0.5.1
211+
[0.5.0]: https://github.com/modem-dev/hunk/compare/v0.4.0...v0.5.0
212+
[0.4.0]: https://github.com/modem-dev/hunk/compare/v0.3.0...v0.4.0
213+
[0.3.0]: https://github.com/modem-dev/hunk/compare/v0.2.0...v0.3.0
214+
[0.2.0]: https://github.com/modem-dev/hunk/compare/v0.1.0...v0.2.0
215+
[0.1.0]: https://github.com/modem-dev/hunk/tree/v0.1.0

0 commit comments

Comments
 (0)