Skip to content

Commit d2e5df3

Browse files
authored
docs: add curated release notes for v0.4.0 (#230)
User-facing notes for extension 0.4.0: CLI 0.28 recommendation, source-aware upgrade remediation, suggested_op peels, and Windows install guidance (managed + Scoop). Signed-off-by: Sebastien Tardif <sebtardif@ncf.ca>
1 parent e521f1e commit d2e5df3

1 file changed

Lines changed: 81 additions & 0 deletions

File tree

RELEASE_NOTES.md

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
# Patchloom for VS Code 0.4.0
2+
3+
This release tracks [Patchloom CLI 0.28.0](https://github.com/patchloom/patchloom/releases/tag/patchloom-v0.28.0): recommended binary bump, clearer agent-facing error hints (`suggested_op`, empty paths, non-regular files), better upgrade actions by install source, and Windows install guidance that prefers managed install and Scoop over lagging community packages.
4+
5+
## Highlights
6+
7+
- **Recommended CLI is 0.28.0.** Managed **Install** / **Update Patchloom** still download the latest GitHub release with checksum verification. Minimum supported CLI remains **0.3.0**.
8+
- **Smarter upgrade actions.** Status and command warnings pick the action that can actually fix your active binary: **Update** for managed installs, **Open Settings** for `patchloom.path`, **Open Releases** for PATH installs. Managed Update no longer pretends to replace an outdated PATH binary.
9+
- **Richer CLI error peels in the UI.** Failure messages still prefer JSON `error` / `error_kind`, and now append `suggested_op` when the CLI provides it (for example multi-match `doc.update` after a fail-closed `doc.set`).
10+
- **Windows install path.** Prefer the extension managed installer or Scoop. Winget and Chocolatey are called out as lagging channels; do not use them when you need the latest CLI the same day.
11+
12+
CLI 0.28 still exposes **58** MCP tools by default (11 in the core pack). No settings migration is required.
13+
14+
## Aligned with Patchloom CLI 0.25–0.28
15+
16+
You do not need every CLI feature to use the extension. These matter if you upgrade the binary from 0.24.x:
17+
18+
| CLI | What you get with a current managed install |
19+
|-----|---------------------------------------------|
20+
| 0.25 | Clearer create/rename peels; ambiguous markdown headings report `error_kind: ambiguous` |
21+
| 0.26 | Multi-path specials (FIFOs and similar) report `refused[].reason: not_regular_file` instead of looking like a permission error |
22+
| 0.27 | Fail-closed doc navigation may include `suggested_op` (`doc.update` or `doc.delete_where`) so agents and the extension can hint the multi-match sibling |
23+
| 0.28 | Empty, whitespace-only, or format-character-only paths fail early with `error_kind: invalid_input` and message `path must not be empty` |
24+
25+
Workspace Quick Actions and Batch Apply still pass global `--contain`. Patch merge still skips containment when the patch file may live outside the project.
26+
27+
## New features
28+
29+
- **CLI 0.28 alignment.** Recommended version, requirements, troubleshooting, and MCP counts updated for 0.25–0.28 peels; Batch Apply template includes multi-match `doc.update` next to `doc.set` ([#226](https://github.com/patchloom/patchloom-vscode/pull/226)).
30+
- **Shared binary remediation.** Missing or broken CLI prompts use one path for status and commands: Install, Reinstall, Update, Settings, or Open Releases depending on source and managed storage ([#228](https://github.com/patchloom/patchloom-vscode/pull/228), [#229](https://github.com/patchloom/patchloom-vscode/pull/229)).
31+
32+
## Bug fixes
33+
34+
- **Managed Update for an outdated PATH CLI left you stuck.** Resolution order is still setting, then PATH, then managed. Offering Install/Update managed when the active binary came from PATH or `patchloom.path` could refresh storage without changing what the extension runs. Upgrade actions now follow the active source ([#229](https://github.com/patchloom/patchloom-vscode/pull/229)).
35+
- **Missing binary only offered Open Settings.** When managed install is available, status and command warnings prefer **Install Patchloom** or **Reinstall Patchloom** instead of sending you only to settings ([#228](https://github.com/patchloom/patchloom-vscode/pull/228)).
36+
37+
## Improvements
38+
39+
- **`suggested_op` in Output and notifications.** When the CLI returns a multi-match hint on fail-closed doc navigation, the extension surfaces it next to the error text ([#226](https://github.com/patchloom/patchloom-vscode/pull/226)).
40+
- **Windows and upgrade docs.** Install and troubleshooting prefer managed install and Scoop; document Scoop/`scoop update` for PATH upgrades and managed Update for storage installs ([#226](https://github.com/patchloom/patchloom-vscode/pull/226), [#229](https://github.com/patchloom/patchloom-vscode/pull/229)).
41+
- **Dependency hygiene.** Cleared high npm audit findings (including brace-expansion override pin) and bumped publishing/test tooling used in CI ([#228](https://github.com/patchloom/patchloom-vscode/pull/228), [#229](https://github.com/patchloom/patchloom-vscode/pull/229), [#223](https://github.com/patchloom/patchloom-vscode/pull/223), [#224](https://github.com/patchloom/patchloom-vscode/pull/224), [#225](https://github.com/patchloom/patchloom-vscode/pull/225)).
42+
43+
## Numbers
44+
45+
| Metric | Notes |
46+
|--------|--------|
47+
| Extension version | 0.3.0 → 0.4.0 |
48+
| Recommended CLI | 0.24.0 → 0.28.0 (minimum still 0.3.0) |
49+
| Unit tests | 313 (node:test unit suite on this release) |
50+
| MCP tools (CLI 0.28 full / core) | 58 / 11 |
51+
52+
## Upgrading
53+
54+
1. Update the extension to **0.4.0** (VS Code Marketplace, Open VSX, or `.vsix` from the GitHub Release).
55+
2. Update the Patchloom CLI using the channel that matches how the extension resolved it (see **Patchloom: Show Status** → Source):
56+
57+
```bash
58+
# Managed install (extension storage): command palette
59+
# Patchloom: Update Patchloom
60+
61+
# PATH via Scoop (preferred Windows PATH channel)
62+
scoop update patchloom
63+
64+
# PATH via Homebrew
65+
brew upgrade patchloom
66+
67+
# npm / cargo / shell installer: see README Install section
68+
```
69+
70+
3. Confirm with **Patchloom: Show Status** that the detected CLI is **0.28.0** or newer (0.3.0+ still runs; 0.28.0 is recommended).
71+
4. Optional: open Batch Apply and try the `doc.update` example, or trigger a command with an outdated PATH binary and confirm the status action points at **Open Releases** rather than a no-op managed update.
72+
73+
## Install
74+
75+
- [VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=patchloom.patchloom)
76+
- [Open VSX](https://open-vsx.org/extension/patchloom/patchloom)
77+
- GitHub Release assets: `patchloom.vsix` and build provenance (`patchloom.vsix.intoto.jsonl`)
78+
79+
## Full changelog
80+
81+
https://github.com/patchloom/patchloom-vscode/compare/patchloom-v0.3.0...patchloom-v0.4.0

0 commit comments

Comments
 (0)