Skip to content
This repository was archived by the owner on Jun 4, 2026. It is now read-only.

Commit b4d2999

Browse files
Chrisclaude
authored andcommitted
docs: add CHANGELOG.md, backfill 1.0.0 + 1.0.1 release notes
Start a proper CHANGELOG. Entries for both 1.0.1 (this branch) and 1.0.0 (backfilled from the commit history of the initial public release). Future releases land here first. Also update CONTRIBUTING section of README to ask for a CHANGELOG bullet on every PR, and add a "Release notes" link so users can find it. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent 1e93baf commit b4d2999

2 files changed

Lines changed: 38 additions & 0 deletions

File tree

CHANGELOG.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Changelog
2+
3+
All notable changes to `boxel-cli`. Format loosely follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/); versions follow [SemVer](https://semver.org/spec/v2.0.0.html).
4+
5+
## 1.0.1 — 2026-04-20
6+
7+
### New
8+
9+
- `boxel push --batch [--batch-size N]` — atomic bulk upload. Definitions upload individually in dependency order (so FieldDefs land before CardDefs that contain them); instances batch through `/_atomic` in groups of N (default 10). Faster and quieter than per-file POST on pushes of 50+ files, and reduces UI re-indexing churn.
10+
- `boxel pull <url> ./local` writes `.boxel-sync.json` automatically after a fresh download. You can now run `boxel sync .` immediately against a just-pulled directory with no manual intermediate step.
11+
12+
### Fixed
13+
14+
- **Binary upload corruption.** Images, fonts, PDFs, and other non-text files were being routed through the `/_atomic` JSON endpoint with text encoding, corrupting the bytes. Binary files now take the per-file POST path with `application/octet-stream`.
15+
- **Plain-text file rejection.** `.md`, `.csv`, `.yaml`, `.xml`, and `.txt` uploads were being rejected by the realm's module compiler as "invalid source". Plain-text files now take the per-file POST path with their true MIME type.
16+
- **Manifest shape drift between push and pull.** `push` and `pull` had diverged on the shape of `.boxel-sync.json`. Mixed-command workflows (pull → push or pull → sync → push) could mark every file as changed on the next run. All three commands now use one canonical shape; `push` migrates the pre-1.0.1 bare-string format on read.
17+
- **Partial-failure batch marks files as synced.** In `--batch` mode, the manifest was updated for every file in a batch whenever any file succeeded, even if some of them had failed. Failed uploads could be silently stranded without retry. The manifest now tracks only files that successfully uploaded; failures stay out and get retried on the next run.
18+
- **`boxel --version` reported wrong number.** The CLI had a hardcoded version string that drifted from `package.json`. Version is now sourced from `package.json` at runtime.
19+
- **`--batch-size` silently accepted garbage.** `--batch-size abc` or `--batch-size -5` used to flow through as `NaN` / negative and cause weird behavior downstream. Non-positive-integer input now fails fast with a clear error.
20+
21+
### For contributors
22+
23+
- New `src/lib/content-type.ts` — single source of truth mapping file extension → MIME type → upload-path decision. Any extension you add for atomic-compatibility should also go here.
24+
- New drift-guards section in `.gitignore` — prevents Boxel platform docs, workspace dirs, and other content that commonly ends up at the repo root from leaking into commits.
25+
- `AGENTS.md` now documents the content-type routing table (file class → path → headers) and the canonical manifest shape, so future additions to `batch-upload.ts` or any manifest-touching command have one reference.
26+
27+
---
28+
29+
## 1.0.0 — 2026-02-13
30+
31+
Initial public release. Core sync, push, pull, watch, track, history, profiles, multi-realm config, realm repair, share/gather GitHub workflow, skill-based Claude Code integration.

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -671,12 +671,19 @@ When you open this repo in Claude Code, it will guide you through setup and prov
671671

672672
---
673673

674+
## Release notes
675+
676+
See [CHANGELOG.md](CHANGELOG.md) for per-version changes.
677+
678+
---
679+
674680
## Contributing
675681

676682
PRs welcome! Please ensure:
677683
- Code passes linting (`npm run lint`)
678684
- New features have documentation
679685
- Breaking changes are noted in PR description
686+
- Add a bullet to `CHANGELOG.md` under the in-progress version (or start a new `## Unreleased` section if one doesn't exist)
680687

681688
---
682689

0 commit comments

Comments
 (0)