Skip to content

docs: update release notes for next release#8270

Merged
steveruizok merged 1 commit intomainfrom
update-release-notes
Mar 18, 2026
Merged

docs: update release notes for next release#8270
steveruizok merged 1 commit intomainfrom
update-release-notes

Conversation

@steveruizok
Copy link
Copy Markdown
Collaborator

@steveruizok steveruizok commented Mar 18, 2026

In order to keep the release notes up to date for the upcoming release, this PR updates apps/docs/content/releases/next.mdx with entries for 15 PRs merged since v4.5.1.

Featured additions include custom record types, WebSocket hibernation support for tlsync, the new @tldraw/editor-controller package, RTL language support, and cross-window embedding support. Also covers 9 API changes, 3 improvements, and 6 bug fixes.

Change type

  • other

Test plan

  • Unit tests
  • End to end tests

No manual testing needed — this is a documentation-only change.

Code changes

Section LOC change
Documentation +84 / -1

@vercel
Copy link
Copy Markdown

vercel bot commented Mar 18, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
examples Ready Ready Preview Mar 18, 2026 11:45am
tldraw-docs Ready Ready Preview Mar 18, 2026 11:45am
4 Skipped Deployments
Project Deployment Actions Updated (UTC)
analytics Ignored Ignored Mar 18, 2026 11:45am
chat-template Skipped Skipped Mar 18, 2026 11:45am
tldraw-shader Skipped Skipped Mar 18, 2026 11:45am
workflow-template Skipped Skipped Mar 18, 2026 11:45am

Request Review

@steveruizok steveruizok changed the title docs: update release notes docs: update release notes for next release Mar 18, 2026
@huppy-bot huppy-bot bot added the other ⚙️ Changes that don't affect SDK users, e.g. internal or .com changes label Mar 18, 2026
@steveruizok steveruizok added this pull request to the merge queue Mar 18, 2026
@steveruizok steveruizok removed this pull request from the merge queue due to a manual request Mar 18, 2026
@steveruizok steveruizok added the docs-hotfix-please ⚙️ Triggers docs hotfix release after merge label Mar 18, 2026
@steveruizok steveruizok added this pull request to the merge queue Mar 18, 2026
Merged via the queue into main with commit b9b3bfd Mar 18, 2026
29 checks passed
@steveruizok steveruizok deleted the update-release-notes branch March 18, 2026 11:53
huppy-bot bot pushed a commit that referenced this pull request Mar 18, 2026
In order to keep the release notes up to date for the upcoming release,
this PR updates `apps/docs/content/releases/next.mdx` with entries for
15 PRs merged since v4.5.1.

Featured additions include custom record types, WebSocket hibernation
support for tlsync, the new `@tldraw/editor-controller` package, RTL
language support, and cross-window embedding support. Also covers 9 API
changes, 3 improvements, and 6 bug fixes.

### Change type

- [x] `other`

### Test plan

- [ ] Unit tests
- [ ] End to end tests

No manual testing needed — this is a documentation-only change.

### Code changes

| Section       | LOC change |
| ------------- | ---------- |
| Documentation | +84 / -1   |
github-merge-queue bot pushed a commit that referenced this pull request Mar 25, 2026
#8276)

In order to stop docs-only hotfixes from triggering unwanted npm patch
releases, this PR adds `yarn refresh-assets --force` before the
`getAnyPackageDiff()` check in `publish-patch.ts`.

### Root cause

PR #8204 added `.yarn/install-state.gz` to the CI cache. When Yarn
determines that the install state hasn't changed (e.g. `node_modules` is
already populated and no dependencies changed), it [skips lifecycle
scripts](https://yarnpkg.com/advanced/lifecycle-scripts) including
`postinstall` ([related
discussion](yarnpkg/berry#5924)). This
means the `postinstall` hook (`husky install && yarn refresh-assets`)
never runs.

Without `refresh-assets`, the gitignored asset directories in
`@tldraw/assets` (`embed-icons/`, `fonts/`, `icons/`, `translations/`)
don't exist on disk. The `getAnyPackageDiff()` guard runs `yarn pack`
which produces a tarball missing these dirs (14 files), while the
npm-published tarball has them (265 files) — always finding a diff,
always publishing.

**Before #8204 (working):** PR #8102 docs hotfix cherry-picked to v4.4.x
— publish-patch skipped correctly, no version bump.

**After #8204 (broken):** PRs #8263 and #8270 docs hotfixes
cherry-picked to v4.5.x — both triggered unwanted npm publishes (v4.5.1
and v4.5.2).

### Why this approach

Considered three options:
1. **Remove `install-state.gz` from cache** — doesn't actually help;
Yarn skips postinstall based on dependency changes, not just the state
file
2. **Add `refresh-assets` to the setup action** — overkill; lazyrepo
already auto-runs it as a dependency of `build`, `build-types`, and
`dev`
3. **Add `refresh-assets` to `publish-patch.ts`** — targeted fix
matching what `trigger-sdk-hotfix.ts` already does (line 98)

Option 3 is the right call. `publish-patch.ts` is the only workflow
confirmed broken — everything else is protected by either lazyrepo's
dependency graph or explicit `refresh-assets` calls in the workflow
YAML.

### Change type

- [x] `bugfix`

### Test plan

Verified locally:
1. Removed asset dirs to simulate CI with warm cache (no postinstall)
2. `yarn pack` on `@tldraw/assets` → 14 files
3. Ran `yarn refresh-assets --force`
4. `yarn pack` again → 265 files

On a release branch with only docs changes, `getAnyPackageDiff()` should
now return `null` → "No packages have changed, skipping release" → no
publish.

### Code changes

| Section        | LOC change |
| -------------- | ---------- |
| Config/tooling | +4 / -0    |
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs-hotfix-please ⚙️ Triggers docs hotfix release after merge other ⚙️ Changes that don't affect SDK users, e.g. internal or .com changes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant