Skip to content

Commit c5d9067

Browse files
committed
docs: Add v0.16.0 CHANGELOG entry with comprehensive release notes
Signed-off-by: phernandez <paul@basicmachines.co>
1 parent e0fc59e commit c5d9067

1 file changed

Lines changed: 234 additions & 0 deletions

File tree

CHANGELOG.md

Lines changed: 234 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,239 @@
11
# CHANGELOG
22

3+
## v0.16.0 (2025-11-10)
4+
5+
### Features
6+
7+
- **#417**: Add run_in_background parameter to sync endpoint
8+
([`7ccec7e`](https://github.com/basicmachines-co/basic-memory/commit/7ccec7e))
9+
- New `run_in_background` parameter for async sync operations
10+
- Improved API flexibility for long-running sync tasks
11+
- Comprehensive test coverage for background sync behavior
12+
13+
- **#405**: SPEC-20 Simplified Project-Scoped Rclone Sync
14+
([`0b3272a`](https://github.com/basicmachines-co/basic-memory/commit/0b3272a))
15+
- Simplified and more reliable cloud synchronization
16+
- Project-scoped rclone configuration
17+
- Better error handling and status reporting
18+
19+
- **#384**: Streaming Foundation & Async I/O Consolidation (SPEC-19)
20+
([`e78345f`](https://github.com/basicmachines-co/basic-memory/commit/e78345f))
21+
- Foundation for streaming support in future releases
22+
- Consolidated async I/O patterns across codebase
23+
- Improved performance and resource management
24+
25+
- **#364**: Add circuit breaker for file sync failures
26+
([`434cdf2`](https://github.com/basicmachines-co/basic-memory/commit/434cdf2))
27+
- Prevents cascading failures during sync operations
28+
- Automatic recovery from transient errors
29+
- Better resilience in cloud sync scenarios
30+
31+
- **#362**: Add --verbose and --no-gitignore options to cloud upload
32+
([`7f9c1a9`](https://github.com/basicmachines-co/basic-memory/commit/7f9c1a9))
33+
- Enhanced upload control with verbose logging
34+
- Option to bypass gitignore filtering when needed
35+
- Better debugging and troubleshooting capabilities
36+
37+
- **#391**: Add delete_notes parameter to remove project endpoint
38+
([`c9946ec`](https://github.com/basicmachines-co/basic-memory/commit/c9946ec))
39+
- Option to delete notes when removing projects
40+
- Safer project cleanup workflows
41+
- Prevents accidental data loss
42+
43+
### Bug Fixes
44+
45+
- **#420**: Skip archive files during cloud upload
46+
([`49b2adc`](https://github.com/basicmachines-co/basic-memory/commit/49b2adc))
47+
- Prevents uploading of zip, tar, gz and other archive files
48+
- Reduces storage usage and upload time
49+
- Better file filtering during cloud operations
50+
51+
- **#419**: Rename write_note entity_type to note_type for clarity
52+
([`1646572`](https://github.com/basicmachines-co/basic-memory/commit/1646572))
53+
- Clearer parameter naming in write_note tool
54+
- Improved API consistency and documentation
55+
- Better developer experience
56+
57+
- **#418**: Quote string values in YAML frontmatter to handle special characters
58+
([`f0d7398`](https://github.com/basicmachines-co/basic-memory/commit/f0d7398))
59+
- Fixes YAML parsing errors with special characters
60+
- More robust frontmatter handling
61+
- Prevents data corruption in edge cases
62+
63+
- **#415**: Handle dict objects in write_resource endpoint
64+
([`4614fd0`](https://github.com/basicmachines-co/basic-memory/commit/4614fd0))
65+
- Fixes errors when writing dictionary resources
66+
- Better type handling in resource endpoints
67+
- Improved API robustness
68+
69+
- **#414**: Replace Unicode arrows with ASCII for Windows compatibility
70+
([`fc01f6a`](https://github.com/basicmachines-co/basic-memory/commit/fc01f6a))
71+
- Fixes display issues on Windows terminals
72+
- Better cross-platform compatibility
73+
- Improved CLI user experience on Windows
74+
75+
- **#411**: Windows CLI Unicode encoding errors
76+
([`0ba6f21`](https://github.com/basicmachines-co/basic-memory/commit/0ba6f21))
77+
- Resolves Unicode encoding issues on Windows
78+
- Better handling of international characters
79+
- Improved Windows platform support
80+
81+
- **#410**: Various rclone fixes for cloud sync on Windows
82+
([`c9946ec`](https://github.com/basicmachines-co/basic-memory/commit/c9946ec))
83+
- Fixes cloud sync reliability on Windows
84+
- Better path handling for Windows filesystem
85+
- Improved rclone integration on Windows
86+
87+
- **#402**: Normalize YAML frontmatter types to prevent AttributeError
88+
([`a7d7cc5`](https://github.com/basicmachines-co/basic-memory/commit/a7d7cc5))
89+
- Fixes AttributeError when reading frontmatter
90+
- More robust type normalization
91+
- Better error handling in markdown parsing
92+
93+
- **#396**: Strip duplicate headers in edit_note replace_section
94+
([`021af74`](https://github.com/basicmachines-co/basic-memory/commit/021af74))
95+
- Prevents duplicate headers when replacing sections
96+
- Cleaner note editing behavior
97+
- Better content consistency
98+
99+
- **#395**: Simplify search_notes schema by removing Optional wrappers
100+
([`d775f7b`](https://github.com/basicmachines-co/basic-memory/commit/d775f7b))
101+
- Cleaner API schema definition
102+
- Better type safety and validation
103+
- Improved developer experience
104+
105+
- **#394**: Add explicit type annotations to MCP tool parameters
106+
([`581b7b1`](https://github.com/basicmachines-co/basic-memory/commit/581b7b1))
107+
- Better type safety in MCP tools
108+
- Improved IDE support and autocomplete
109+
- Clearer tool documentation
110+
111+
- **#389**: Handle null, empty, and string 'None' title in markdown frontmatter
112+
([`bb8da31`](https://github.com/basicmachines-co/basic-memory/commit/bb8da31))
113+
- Fixes errors with malformed frontmatter titles
114+
- More robust title handling
115+
- Better error recovery
116+
117+
- **#380**: Optimize sync memory usage to prevent OOM on large projects
118+
([`4fd6d0c`](https://github.com/basicmachines-co/basic-memory/commit/4fd6d0c))
119+
- Prevents out-of-memory errors on large knowledge bases
120+
- Better memory management during sync
121+
- Improved scalability
122+
123+
- **#379**: Handle YAML parsing errors gracefully in update_frontmatter
124+
([`32236cd`](https://github.com/basicmachines-co/basic-memory/commit/32236cd))
125+
- Better error handling for malformed YAML
126+
- Graceful degradation instead of crashes
127+
- Improved robustness
128+
129+
- **#377**: Preserve mtime on WebDAV upload
130+
([`e6c8e36`](https://github.com/basicmachines-co/basic-memory/commit/e6c8e36))
131+
- Maintains file modification times during upload
132+
- Better sync accuracy
133+
- Prevents unnecessary re-syncing
134+
135+
- **#370**: Prevent deleted projects from being recreated by background sync
136+
([`449b62d`](https://github.com/basicmachines-co/basic-memory/commit/449b62d))
137+
- Fixes race condition with project deletion
138+
- Better lifecycle management
139+
- Prevents unwanted project recreation
140+
141+
- **#369**: Use filesystem timestamps for entity sync instead of database operation time
142+
([`b7497d7`](https://github.com/basicmachines-co/basic-memory/commit/b7497d7))
143+
- More accurate sync detection
144+
- Better handling of external file modifications
145+
- Improved sync reliability
146+
147+
- **#368**: Handle YAML parsing errors and missing entity_type in markdown files
148+
([`d1431bd`](https://github.com/basicmachines-co/basic-memory/commit/d1431bd))
149+
- Better error handling for malformed markdown
150+
- Graceful handling of missing metadata
151+
- Improved robustness
152+
153+
- **#367**: Resolve UNIQUE constraint violation in entity upsert with observations
154+
([`171bef7`](https://github.com/basicmachines-co/basic-memory/commit/171bef7))
155+
- Fixes database constraint errors during sync
156+
- Better handling of duplicate observations
157+
- Improved data integrity
158+
159+
- **#366**: Terminate sync immediately when project is deleted
160+
([`729a5a3`](https://github.com/basicmachines-co/basic-memory/commit/729a5a3))
161+
- Faster project deletion
162+
- Better resource cleanup
163+
- Improved user experience
164+
165+
- **#357**: Make project creation endpoint idempotent
166+
([`53fb13b`](https://github.com/basicmachines-co/basic-memory/commit/53fb13b))
167+
- Prevents errors when creating existing projects
168+
- Better API reliability
169+
- Improved cloud integration
170+
171+
- **#353**: Handle None text values in Claude conversations importer
172+
([`bd6c834`](https://github.com/basicmachines-co/basic-memory/commit/bd6c834))
173+
- Fixes import errors with empty messages
174+
- Better error handling in importers
175+
- Improved data migration
176+
177+
### Performance Improvements
178+
179+
- Force full database sync after project sync/bisync operations
180+
([`2ad0ee9`](https://github.com/basicmachines-co/basic-memory/commit/2ad0ee9))
181+
- Ensures database consistency after cloud operations
182+
- Better sync reliability
183+
- Improved data integrity
184+
185+
### Documentation
186+
187+
- Add free trial information to README
188+
([`a7d7cc5`](https://github.com/basicmachines-co/basic-memory/commit/a7d7cc5), [`8aaddb6`](https://github.com/basicmachines-co/basic-memory/commit/8aaddb6))
189+
- Updated README with Basic Memory Cloud trial info
190+
- Better onboarding experience
191+
- Clearer pricing information
192+
193+
- Announce Basic Memory Cloud launch in README
194+
([`d756531`](https://github.com/basicmachines-co/basic-memory/commit/d756531))
195+
- Official cloud service announcement
196+
- Updated documentation for cloud features
197+
- Improved product positioning
198+
199+
### Migration Guide
200+
201+
No manual migration required. Upgrade with:
202+
203+
```bash
204+
# Update via uv
205+
uv tool upgrade basic-memory
206+
207+
# Or install fresh
208+
uv tool install basic-memory
209+
```
210+
211+
**What's New in v0.16.0:**
212+
- Streaming foundation and consolidated async I/O (SPEC-19)
213+
- Simplified project-scoped rclone sync (SPEC-20)
214+
- Circuit breaker for sync failure resilience
215+
- Enhanced Windows platform support
216+
- Improved cloud upload with verbose and gitignore options
217+
- Better error handling across YAML parsing and frontmatter
218+
- Memory optimization for large projects
219+
- Archive file filtering during upload
220+
221+
**Breaking Changes:**
222+
- `write_note` parameter renamed: `entity_type``note_type` for clarity
223+
224+
### Installation
225+
226+
```bash
227+
# Latest stable release
228+
uv tool install basic-memory
229+
230+
# Update existing installation
231+
uv tool upgrade basic-memory
232+
233+
# Docker
234+
docker pull ghcr.io/basicmachines-co/basic-memory:v0.16.0
235+
```
236+
3237
## v0.15.2 (2025-10-14)
4238

5239
### Features

0 commit comments

Comments
 (0)