Skip to content

Update documentation for verified v0.2.5 publication #32

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
erickkkyt merged 1 commit into from
Oct 21, 2026
Merged

Update documentation for verified v0.2.5 publication #32

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

All notable changes to BeatDesign are documented in this file.

## Unreleased — v0.2.5 candidate
## [0.2.5] - 2026-10-22

### Added

Expand All @@ -24,7 +24,7 @@ All notable changes to BeatDesign are documented in this file.

### Maintenance

- Prepare v0.2.5 application and integration metadata; publication remains pending.
- Align v0.2.5 application and integration metadata.
- Replace Unix-only postinstall commands with a Node.js setup script. Verify clean installation, schema setup, build, types, tests and translations on Linux and Windows in CI.
- Run browser/MCP checks against the production build so development reloads and Vite error overlays cannot interrupt release validation.
- Pin Node.js 24-compatible GitHub Actions and explicit runner images; adopt the current server-function validator API and explicit Vite config import extensions.
Expand All @@ -33,7 +33,7 @@ All notable changes to BeatDesign are documented in this file.
### Documentation

- Document source upgrade steps and project-setting revision/cover handling in Codex, Claude Code and WorkBuddy Skills.
- Highlight current source updates in English, Chinese and Japanese READMEs, while distinguishing them from the v0.2.4 release and package. Update the MCP catalog and current product status.
- Highlight v0.2.5 features and source upgrade steps in English, Chinese and Japanese READMEs. Update the MCP catalog and current product status.

## [0.2.4] - 2026-09-23

Expand Down Expand Up @@ -153,6 +153,7 @@ All notable changes to BeatDesign are documented in this file.
- MP4 export remains browser-driven and is not yet available as a headless MCP tool.
- Caption style presets, transitions, speed controls, multiple named timelines, and native desktop packaging remain follow-up work.

[0.2.5]: https://github.com/BeatAPI/BeatDesign/releases/tag/v0.2.5
[0.2.4]: https://github.com/BeatAPI/BeatDesign/releases/tag/v0.2.4
[0.2.2]: https://github.com/BeatAPI/BeatDesign/releases/tag/v0.2.2
[0.2.1]: https://github.com/BeatAPI/BeatDesign/releases/tag/v0.2.1
Expand Down
6 changes: 3 additions & 3 deletions README.ja.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,11 @@

BeatDesignは、AI画像・動画制作のための独立したオープンソース、ローカルファーストのワークスペースです。Higgsfieldのような一貫した制作フローを、自分のマシンで実行、確認、拡張したい人に向けて作られています。

## 最近のソース更新 · 2026年10月
## 最新リリース · v0.2.5 · 2026年10月

以下は`main`の更新です。最新の正式Releaseとnpmパッケージは引き続き **v0.2.4** です。利用するにはソースを更新してください。既存のパッケージへ自動配信されるものではありません。
以下の更新は[GitHub Release v0.2.5](https://github.com/BeatAPI/BeatDesign/releases/tag/v0.2.5)と`@beatapi/beatdesign-workbuddy@0.2.5`で公開済みです。WorkBuddyマーケットの審査・公開状況は別途確認してください。

リポジトリと連携用マニフェストは **v0.2.5** に更新済みですが、公開は保留中です。ソース版を更新する場合はBeatDesignを停止し、`git pull --ff-only`、`pnpm install --frozen-lockfile`、`pnpm db:push` の順に実行してから、`pnpm dev:agent`（または通常のUI/MCP起動コマンド）を再起動してください。ローカルデータを保持し、Projectを初期化しないでください。
ソース版を更新する場合はBeatDesignを停止し、`git pull --ff-only`、`pnpm install --frozen-lockfile`、`pnpm db:push` の順に実行してから、`pnpm dev:agent`（または通常のUI/MCP起動コマンド）を再起動してください。ローカルデータを保持し、Projectを初期化しないでください。

- **Project設定とカバー：** 名前と説明の編集、画像カバーのアップロード・選択、自動カバーへのリセットに対応。手動カバーは後の読み込みや生成で置き換わりません。Projectカードまたはワークスペース上部の設定アイコンから開きます。
- **生成バージョンの一致：** CanvasのプレビューとTake選択が最新の成功結果を示します。手動選択とTimelineの固定Assetは保持されます。
Expand Down
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,11 @@

BeatDesign is an independent, open-source, local-first workspace for AI image and video creation. It is built for people who want the connected creative flow of tools such as Higgsfield, with a workspace they can run, inspect, and extend on their own machine.

## Latest source updates — October 2026
## Latest release — v0.2.5 · October 2026

Available on `main`; the latest tagged release and npm package remain **v0.2.4**. Pull the source to use these updates; existing packaged installations do not receive them automatically.
Available in [GitHub Release v0.2.5](https://github.com/BeatAPI/BeatDesign/releases/tag/v0.2.5) and `@beatapi/beatdesign-workbuddy@0.2.5`. WorkBuddy marketplace review and availability are tracked separately.

The repository and integration manifests are prepared for **v0.2.5**; publication is pending. For an existing source checkout, stop BeatDesign, run `git pull --ff-only`, `pnpm install --frozen-lockfile`, `pnpm db:push`, then restart `pnpm dev:agent` (or your usual UI/MCP commands). Keep your local data directory; no reinstall or project reset is needed.
For an existing source checkout, stop BeatDesign, run `git pull --ff-only`, `pnpm install --frozen-lockfile`, `pnpm db:push`, then restart `pnpm dev:agent` (or your usual UI/MCP commands). Keep your local data directory; no reinstall or project reset is needed.

- **Project settings:** edit names and descriptions, upload or select a cover, and reset to an automatic image or local video poster. A manual cover stays selected after later imports and generations. Open the settings icon on a project card or workspace header.
- **Consistent generation versions:** Canvas previews and Take selection agree on the latest successful output; manual selections and concrete timeline Assets are preserved.
Expand Down
6 changes: 3 additions & 3 deletions README.zh-CN.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,11 @@

BeatDesign 是一个独立、开源、本地优先的 AI 图片与视频创作工作台。它适合喜欢 Higgsfield 这类连贯创作流程，同时希望在自己的电脑上运行、检查和扩展工作空间的人。

## 最近更新 · 2026 年 10 月
## 最新版本 · v0.2.5 · 2026 年 10 月

以下更新位于 `main` 源码；最新正式 Release 和 npm 包仍为 **v0.2.4**。拉取源码后即可使用，现有安装包不会自动获得这些更新。
以下更新已发布至 [GitHub Release v0.2.5](https://github.com/BeatAPI/BeatDesign/releases/tag/v0.2.5) 和 `@beatapi/beatdesign-workbuddy@0.2.5`。WorkBuddy 市场审核与上架状态单独跟踪。

仓库与接入包元数据已准备为 **v0.2.5**，尚未发布。已有源码用户请先停止 BeatDesign，再依次运行 `git pull --ff-only`、`pnpm install --frozen-lockfile`、`pnpm db:push`，随后重启 `pnpm dev:agent`（或原有 UI/MCP 启动命令）。保留本地数据目录，无需重装或重置项目。
已有源码用户请先停止 BeatDesign，再依次运行 `git pull --ff-only`、`pnpm install --frozen-lockfile`、`pnpm db:push`，随后重启 `pnpm dev:agent`（或原有 UI/MCP 启动命令）。保留本地数据目录，无需重装或重置项目。

- **项目设置与稳定封面：** 修改项目名称和简介，上传或选择封面，或恢复自动封面。手动封面不会被后续导入、生成的素材替换。入口在项目卡片和工作区顶栏的设置图标。
- **生成版本保持一致：** 画布预览和 Take 选择默认指向最新成功结果，同时保留手动选择和时间线锁定的具体素材。
Expand Down
7 changes: 4 additions & 3 deletions docs/PRODUCT_PLAN_AND_STATUS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,15 @@
- 当前基线：BeatDesign v0.2 Phase 1 本地实现
- 最后核对：2026-10-22
- 事实边界：只有代码、测试和本文“已完成”栏目共同证明的能力才算完成；规划项不等于已发布
- 发布状态：GitHub 最新正式 Release 为 [v0.2.4](https://github.com/BeatAPI/BeatDesign/releases/tag/v0.2.4)；npm 最新版本为 `@beatapi/beatdesign-workbuddy@0.2.4`（2026-10-22 核验）。仓库与接入包元数据已准备为 v0.2.5，尚未发布。WorkBuddy 开放平台中，原有连接器 `oc_321d021032343aea` 的 v0.2.3 已发布，v0.2.4 已提交更新并显示“审核中”；新版通过审核和公开市场可检索性均未核验。
- 发布状态：GitHub 最新正式 Release 为 [v0.2.5](https://github.com/BeatAPI/BeatDesign/releases/tag/v0.2.5)；npm 最新版本为 `@beatapi/beatdesign-workbuddy@0.2.5`（2026-10-22 核验）。WorkBuddy 开放平台最后观测（2026-09-23）：原有连接器 `oc_321d021032343aea` 的 v0.2.3 已发布，v0.2.4 已提交更新并显示“审核中”；新版通过审核和公开市场可检索性均未核验。

### 2026-10 主分支更新（尚未发布新版本）
### v0.2.5 已发布改进

- 整合社区 PR #22、#24、#26、#28：直接创建项目、MCP 导出音量修复、最新成功生成版本统一选择、项目设置与手动／自动封面。
- `bdesign_project_update` 将 MCP 目录扩展为 30 个工具；项目设置更新与幂等回执在同一 SQLite 事务提交，回执失败时回滚设置，保留旧项目封面。
- 浏览器/MCP 检查使用生产构建；画布完成编辑器与项目初始化后才开放工具栏和快捷键，延迟加载回归检查确认首次创建动作可保存。
- 从 PR #18 提取 Windows 测试兼容、Studio 首屏翻译、空画布撤销／重做保存及窄屏布局修复；第三方品牌、Provider 和托管部署配置未纳入上游。
- v0.2.5 待发布候选补齐跨平台安装脚本、Linux/Windows CI、接入包版本和项目设置 Skill 指引；README 分开标注源码更新与 v0.2.4 安装包。官方 Skill 目录仍为空，Issue #29 的持久分组、素材文件夹和复用模板仍待实现。
- v0.2.5 补齐跨平台安装脚本、Linux/Windows CI、接入包版本和项目设置 Skill 指引；README 列出 v0.2.5 功能、正式发布入口与源码升级步骤。官方 Skill 目录仍为空，Issue #29 的持久分组、素材文件夹和复用模板仍待实现。

### v0.2.4 已发布改进

Expand Down
18 changes: 9 additions & 9 deletions docs/RELEASE_SCOPE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,21 +8,21 @@ Excluded: authentication, login, accounts, payments, subscriptions, credits, API

Release verification requires a clean install, schema creation, production build (which generates Paraglide and route types), typecheck, test, i18n check, MCP stdio handshake, and local route smoke test. Browser/MCP checks run against that production build; run `pnpm build` before `pnpm test:e2e`. A real paid BeatAPI generation is a separate credentialed end-to-end check.

## v0.2.5 candidate (not published)
## v0.2.5 release (2026-10-22)

- [x] Align application, Codex, Claude Code, Claude marketplace, LobeHub and WorkBuddy metadata on `0.2.5`.
- [x] Verify clean installation and schema setup on Linux and Windows in CI ([candidate run](https://github.com/BeatAPI/BeatDesign/actions/runs/39647018659), source commit `cbc6951`).
- [x] Verify clean installation and schema setup on Linux and Windows in CI ([release-commit run](https://github.com/BeatAPI/BeatDesign/actions/runs/39649891401), source commit `796d89f0f451b436877836f91392152f43c3e270`).
- [x] Run typecheck, tests (432 passing), i18n validation, production build and focused UI/MCP checks (14 passing).
- [x] Build and inspect the Connector ZIP and npm runtime tarball; install the tarball in a clean temporary directory, complete MCP handshake (30 tools), and smoke-test the production workspace.
- Merge and main-branch CI status: [maintenance PR #31](https://github.com/BeatAPI/BeatDesign/pull/31) and its linked Quality checks. Recheck the exact merge commit before publishing.
- [ ] Publish GitHub Release `v0.2.5` with verified assets.
- [ ] Publish `@beatapi/beatdesign-workbuddy@0.2.5`; independently verify npm `latest`.
- [x] Merge [maintenance PR #31](https://github.com/BeatAPI/BeatDesign/pull/31); both main-branch CI jobs pass on the exact release commit.
- [x] Publish [GitHub Release v0.2.5](https://github.com/BeatAPI/BeatDesign/releases/tag/v0.2.5) with the tested npm tarball, Connector ZIP and SHA-256 checksums. Public tag resolves to `796d89f0f451b436877836f91392152f43c3e270`; GitHub asset digests match the local files.
- [x] Publish `@beatapi/beatdesign-workbuddy@0.2.5`; the public registry reports `latest = 0.2.5`, publication timestamp `2026-10-21T18:18:02.264Z`, and SHA-512 integrity matching the tested release tarball.
- [ ] Submit the updated Connector to WorkBuddy, then record review and public availability separately.

The version in repository metadata identifies the next candidate, not a published
release. Latest public GitHub Release and npm package remain `v0.2.4` (checked
2026-10-22). WorkBuddy's last observed review state remains the dated v0.2.4
submission below.
GitHub Release and npm publication were independently read back on 2026-10-22.
The npm version became publicly available after publish-time scanning; the CLI
success receipt alone was not used as proof of availability. WorkBuddy's last
observed review state remains the dated v0.2.4 submission below.

## v0.2.4 release and WorkBuddy update

Expand Down