Skip to content

Commit 52da2d7

Browse files
committed
docs(CHANGES): Document path contraction as breaking change for v1.41.x
why: Users consuming JSON/NDJSON output need to know about the change what: - Add Breaking Changes section to v1.41.x unreleased notes - Document that all commands (list, status, sync) now use ~/ - Show before/after JSON examples - Explain rationale: consistency, privacy, portability - Note impact: automation may need to expand ~ if required Breaking change: path field changed from /home/user/... to ~/...
1 parent 2c4e749 commit 52da2d7

File tree

1 file changed

+27
-1
lines changed

1 file changed

+27
-1
lines changed

CHANGES

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,33 @@ $ pipx install --suffix=@next 'vcspull' --pip-args '\--pre' --force
3131

3232
<!-- Maintainers, insert changes / features for the next release here -->
3333

34-
_Notes on upcoming releases will be added here_
34+
### Breaking Changes
35+
36+
#### JSON/NDJSON paths now use tilde notation
37+
38+
**All commands** (`list`, `status`, `sync`) now contract home directory paths in JSON/NDJSON output for consistency, privacy, and portability.
39+
40+
**Before:**
41+
```json
42+
{
43+
"name": "flask",
44+
"path": "/home/username/code/flask",
45+
"workspace_root": "~/code/"
46+
}
47+
```
48+
49+
**After:**
50+
```json
51+
{
52+
"name": "flask",
53+
"path": "~/code/flask",
54+
"workspace_root": "~/code/"
55+
}
56+
```
57+
58+
**Why:** The `workspace_root` field already used tilde notation in JSON output, creating an inconsistency. Full home paths (`/home/username/`) expose usernames and make output less portable between machines.
59+
60+
**Impact:** Automation consuming JSON/NDJSON output will need to expand `~` to absolute paths if required. Most tools handle tilde expansion automatically.
3561

3662
## vcspull v1.40.0 (2025-10-19)
3763

0 commit comments

Comments
 (0)