Skip to content

docs: include Svelte Tree migration in release preparation - #159

Merged
elonehoo merged 1 commit into
mainfrom
docs/154-tree-release-notes
Oct 21, 2026
Merged

elonehoo merged 1 commit into
mainfrom
docs/154-tree-release-notes

Conversation

@elonehoo

@elonehoo elonehoo commented Oct 21, 2026 •

Copy link
Copy Markdown
Member

Summary

  • Add a release-note preparation checklist to the existing release-scope guide and link it from the root README.
  • Stage the breaking Svelte Tree default-element, focus/tab-order, and public-type changes from fix(svelte)!: remove Tree branch trigger's extra native tab stop #60, linking the existing migration guide instead of duplicating its examples.
  • Document the actual tag-triggered changelogithub path and its manual verification requirement: this guide is not automatically injected into generated notes, and changelog generation can fail without blocking npm publication.

Refs #154. No release version is selected, no release is claimed, and no GitHub Release, npm publication, tag, merge, or issue closure is performed. This is a documentation-only patch based on main, independent of unmerged #157 and #158.

Validation

  • ESLint on both changed Markdown files: passed.
  • git diff --check: passed.
  • Offline publish-scope guard: passed (9 workspaces, 4 public targets).
  • Native publish-guard regression tests: 383 passed.
  • Independent documentation review: no blockers.

No component runtime or release workflow behavior changes; full browser/component builds were not rerun locally for this documentation-only patch.


View with [code]smith Autofix with [code]smith
Need help on this PR? Tag @codesmith-bot with what you need.


Note

Low Risk
Documentation-only changes to README and release-scope; no runtime, publish guard, or workflow behavior changes.

Overview
Adds release-note preparation guidance to the release process: the root README now points maintainers at docs/release-scope.md#release-note-preparation before cutting a release.

The release-scope doc gains a new section that explains the tag-triggered Release workflow and changelogithub generation, and stresses that breaking-change and migration text must be prepared and manually verified on the GitHub release because generated notes are not fed from this doc and changelog generation can fail without blocking npm publish.

It also stages a pending breaking-change note for the next release that includes Svelte Tree.BranchTrigger changes from #60 (default div/role="button" vs native button, focus/tab ownership, and public types moving to HTMLDivElement), with a link to the existing Svelte migration guide. The former publish-guard content is grouped under a ### Publish guard heading for clearer structure.

Reviewed by Cursor Bugbot for commit fcec6a1. Bugbot is set up for automated code reviews on this repo. Configure here.

@vercel

vercel Bot commented Oct 21, 2026 •

Copy link
Copy Markdown

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

Project Deployment Actions Updated
destyler-ui Ready Ready Preview Oct 21, 2026 7:44am UTC
destyler-ui-dev Ready Ready Preview Oct 21, 2026 7:44am UTC

@elonehoo
elonehoo marked this pull request as ready for review October 21, 2026 07:35
@elonehoo
elonehoo marked this pull request as draft October 21, 2026 07:35
@elonehoo
elonehoo marked this pull request as ready for review October 21, 2026 07:47
@elonehoo

Copy link
Copy Markdown
Member Author

🤖 Review(中文)

基于提交:fcec6a1

概要: 本 PR 为纯文档改动(README.md +2,docs/release-scope.md +42),新增发布说明准备清单,并为 #60(Svelte Tree.BranchTrigger 破坏性变更)预置待发布说明。我核对了文中的事实描述,均与仓库现状一致:

  • 根 package.json 的 release 脚本确实是 bumpp ... --commit --push --tag;
  • .github/workflows/release.yml 由 v* tag 触发,npx changelogithub 带有 continue-on-error: true,且在 publish:ci 之前运行,所以“changelog 失败不会阻止 npm 发布”的说法准确;
  • packages/svelte/README.md 中存在 ## Tree branch triggers 标题,锚点 #tree-branch-triggers 可用;
  • fix(svelte)!: remove Tree branch trigger's extra native tab stop #60 于 2026-10-02 合并,而最新 release v0.0.1-beta.17 发布于 2026-09-02,因此“尚未发布”的表述成立。

建议:

  1. 章节层级(docs/release-scope.md):“Release-note preparation” 是发布前的准备步骤,现在作为 ## Explicit publishing 下的 H3,并把原有内容挪到 ### Publish guard 下。可以考虑把它提升为与 ## Explicit publishing 并列的 H2(放在其前面),结构上更清晰;锚点 #release-note-preparation 不变,README 链接无需修改。
  2. 链接风格一致:同一段里 workflow 用的是相对路径(../.github/workflows/release.yml),而迁移指南用的是绝对的 blob/main URL。建议改为相对路径 ../packages/svelte/README.md#tree-branch-triggers,在分支 / fork 中预览时也能指向同一版本的文档。
  3. 防止“待发布说明”过期:文中要求发布后手动替换此条目,但没有任何机制提醒。建议在 Include the existing Svelte Tree migration guidance in the next release notes #154 或新 issue 中记录一个跟进项(例如发布后更新此段落),或在 release 流程中加一句检查项,避免它长期滞留。
  4. 长期改进(非本 PR 阻塞项):既然文档明确指出 changelogithub 失败不会阻止发布、生成的说明也不会包含这些迁移信息,可以考虑后续单独讨论:发布后加一个校验步骤,或去掉 continue-on-error。
  5. 与 test: gate UI releases on exact-core Dialog consumers #157 的潜在漂移:test: gate UI releases on exact-core Dialog consumers #157(目前为草稿)也修改了 .github/workflows/release.yml。如果它先合并并改变了 changelog / 发布顺序,这里的描述需要同步更新。

测试: 纯文档改动,PR 描述中的 ESLint、git diff --check 和发布守卫测试已足够。

结论: 内容准确、范围克制,可以合并;以上建议均为非阻塞的小改进。

@elonehoo

Copy link
Copy Markdown
Member Author

🤖 Review (English)

Based on commit: fcec6a1

Summary: Documentation-only change (README.md +2, docs/release-scope.md +42) that adds a release-note preparation checklist and stages a pending breaking-change note for #60 (Svelte Tree.BranchTrigger). I checked the factual claims against the repo and they all hold:

  • The root package.json release script is indeed bumpp ... --commit --push --tag.
  • .github/workflows/release.yml is triggered by v* tags, and npx changelogithub runs with continue-on-error: true before publish:ci, so "changelog generation can fail without blocking npm publication" is accurate.
  • packages/svelte/README.md has a ## Tree branch triggers heading, so the #tree-branch-triggers anchor resolves.
  • fix(svelte)!: remove Tree branch trigger's extra native tab stop #60 was merged on 2026-10-02, while the latest release v0.0.1-beta.17 is from 2026-09-02, so "not yet published" is correct.

Suggestions:

  1. Heading structure (docs/release-scope.md): "Release-note preparation" is a pre-release step but is nested as an H3 under ## Explicit publishing, with the existing content moved under ### Publish guard. Consider making it a sibling H2 placed before ## Explicit publishing. The #release-note-preparation anchor stays the same, so the README link keeps working.
  2. Consistent link style: In the same section the workflow link is relative (../.github/workflows/release.yml) but the migration guide uses an absolute blob/main URL. Using ../packages/svelte/README.md#tree-branch-triggers keeps it consistent and points to the matching version when viewed on a branch or fork.
  3. Keep the pending note from going stale: The doc asks maintainers to replace the note after release, but nothing reminds them. Consider tracking that in Include the existing Svelte Tree migration guidance in the next release notes #154 or a follow-up issue, or adding a checklist line to the release process.
  4. Longer-term (not blocking this PR): Since the doc now states that a changelogithub failure doesn't block publishing and that generated notes won't include these migration details, it may be worth a separate discussion about a post-release verification step or dropping continue-on-error.
  5. Possible drift with test: gate UI releases on exact-core Dialog consumers #157: test: gate UI releases on exact-core Dialog consumers #157 (currently a draft) also edits .github/workflows/release.yml. If it lands first and changes the changelog or publish order, this description will need updating.

Tests: For a docs-only change, the ESLint, git diff --check, and publish-guard runs listed in the description are sufficient.

Verdict: Accurate and well-scoped; fine to merge. All suggestions above are minor and non-blocking.

@elonehoo

Copy link
Copy Markdown
Member Author

🤖 レビュー(日本語)

対象コミット:fcec6a1

概要: ドキュメントのみの変更(README.md +2、docs/release-scope.md +42)で、リリースノート準備のチェックリストを追加し、#60(Svelte Tree.BranchTrigger の破壊的変更)向けの保留中ノートを用意しています。記載内容をリポジトリと照合したところ、すべて正確でした。

  • ルート package.json の release スクリプトは確かに bumpp ... --commit --push --tag です。
  • .github/workflows/release.yml は v* タグで起動し、npx changelogithub は continue-on-error: true 付きで publish:ci より前に実行されるため、「changelog 生成が失敗しても npm 公開は止まらない」という記述は正しいです。
  • packages/svelte/README.md に ## Tree branch triggers 見出しがあり、#tree-branch-triggers アンカーは有効です。
  • fix(svelte)!: remove Tree branch trigger's extra native tab stop #60 のマージは 2026-10-02、最新リリース v0.0.1-beta.17 は 2026-09-02 なので、「まだ公開されていない」という記述も正しいです。

提案:

  1. 見出し構成(docs/release-scope.md): 「Release-note preparation」はリリース前の準備手順ですが、## Explicit publishing の下の H3 になっており、既存の内容は ### Publish guard の下に移されています。## Explicit publishing の前に置く同レベルの H2 にすると構造が分かりやすくなります。アンカー #release-note-preparation は変わらないので、README のリンクもそのまま使えます。
  2. リンク形式の統一: 同じセクション内で、ワークフローへのリンクは相対パス(../.github/workflows/release.yml)なのに、移行ガイドは blob/main の絶対 URL です。../packages/svelte/README.md#tree-branch-triggers にすると形式が揃い、ブランチやフォークで見たときも同じバージョンの文書を指せます。
  3. 保留中ノートの陳腐化防止: リリース後にこのノートを置き換えるよう書かれていますが、それを思い出させる仕組みがありません。Include the existing Svelte Tree migration guidance in the next release notes #154 か別の issue でフォローアップとして記録するか、リリース手順にチェック項目を1行追加することをおすすめします。
  4. 長期的な改善(この PR のブロッカーではありません): changelogithub の失敗が公開を止めず、生成ノートに移行情報が含まれないことを文書で明示した以上、リリース後の検証ステップの追加や continue-on-error の削除を別途検討する価値があります。
  5. test: gate UI releases on exact-core Dialog consumers #157 とのずれの可能性: test: gate UI releases on exact-core Dialog consumers #157(現在ドラフト)も .github/workflows/release.yml を変更しています。先にマージされて changelog や公開の順序が変わった場合は、この記述も更新が必要です。

テスト: ドキュメントのみの変更なので、説明に記載された ESLint、git diff --check、publish guard のテストで十分です。

結論: 内容は正確で範囲も適切です。マージして問題ありません。上記の提案はいずれも軽微で、ブロッカーではありません。

@elonehoo
elonehoo merged commit 7a53239 into main Oct 21, 2026
14 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant