Skip to content

docs: document native host APIs available since v10.57.0 - #38

Merged
sunnylqm merged 12 commits into
masterfrom
docs/native-host-update-api
Sep 19, 2026
Merged

sunnylqm merged 12 commits into
masterfrom
docs/native-host-update-api

Conversation

@sunnylqm

@sunnylqm sunnylqm commented Sep 19, 2026

Copy link
Copy Markdown
Contributor

配套版本

SDK PR reactnativecn/react-native-update#641 已合并。原生配置与主动检查功能已随 react-native-update v10.57.0 发布到 npm,且已验证 registry latest 和发布包中的原生接口及 Harmony HAR。

发布说明:https://github.com/reactnativecn/react-native-update/releases/tag/v10.57.0

文档内容

  • site/pages/docs/native-api.mdx:原生 configure → 正常启动 bundle 解析 → checkAndUpdate 的完整顺序,以及 Java/Kotlin、Objective-C/Swift、HarmonyOS ArkTS 示例。
  • 原生 configure、checkAndUpdate 和 JS nativeConfigSource 统一明确为 v10.57.0+,删除此前未发布和仅 PR 可用的说明。
  • 配置校验、默认值、JS/native 配置所有权、每进程轮次共享、结果状态和下次启动激活等规则。
  • site/pages/docs/api.mdx:nativeConfigSource 版本要求及原生指南入口;原有 disableNativeCheck 的 v10.52.1+ 说明保持不变。
  • 高阶侧栏增加原生指南入口;保留必须重建原生安装包/HAR 的提醒。

验证

Node 24 下站点生产构建和文档索引生成通过,已验证 native-api HTML 中包含 v10.57.0 版本要求和 nativeConfigSource:
https://github.com/reactnativecn/pushy-site/actions/runs/35415991538

临时验证 workflow 已删除。最终差异仅包含原生指南、API 参考及侧栏。合并后由现有 GitHub Pages 工作流部署。

@netlify

netlify Bot commented Sep 19, 2026

Copy link
Copy Markdown

Deploy Preview for pushy-site ready!

Name Link
🔨 Latest commit f575e2a
🔍 Latest deploy log https://app.netlify.com/projects/pushy-site/deploys/6aadf4dcf80dd60008059756
😎 Deploy Preview https://deploy-preview-38--pushy-site.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@coderabbitai

coderabbitai Bot commented Sep 19, 2026

Copy link
Copy Markdown

Review Change StackReview Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Advanced

Run ID: 73fee7b1-cd3b-4822-b0e2-f84adab372b1

📥 Commits

Reviewing files that changed from the base of the PR and between fe03458 and 2691b3a.

📒 Files selected for processing (2)
  • site/pages/docs/native-api.mdx
  • site/rspress.config.ts

Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review.


📝 Walkthrough

Walkthrough

The PR adds documentation for native hot-update checks on Android, iOS, and HarmonyOS. It defines prerequisites, APIs, result statuses, per-process update-round behavior, activation timing, configuration limits, and verification steps. The documentation sidebar links to the new page.

Changes

Native API documentation

Layer / File(s) Summary
API entry points and prerequisites
site/pages/docs/native-api.mdx
Documents JS initialization requirements and native update entry points for Android, iOS, and HarmonyOS, including callback behavior and result accessors.
Results and update lifecycle
site/pages/docs/native-api.mdx
Defines result fields and statuses, shared native update rounds, next-launch activation, disabled checks, debug behavior, and update limitations.
Navigation and verification
site/pages/docs/native-api.mdx, site/rspress.config.ts
Adds release-build verification guidance and links the new page from the documentation sidebar.

Priority: ⬇️ Low

Estimated code review effort: 2 (Simple) | ~15 minutes

Change: Other

Merge Risk: ⚪ Minimal · up to 2691b

The documentation and sidebar change have no remaining identified merge-blocking risk.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 1…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly identifies the main change: documenting native host APIs and the SDK version associated with them.
✨ Finishing Touches
📝 Generate docstrings
  • Commit to this branch
  • Create a new PR
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@sunnylqm sunnylqm changed the title docs: add native host check-and-update usage guide docs: add native configuration and check-and-update guide Sep 19, 2026
@sunnylqm sunnylqm changed the title docs: add native configuration and check-and-update guide docs: document native host APIs available since v10.57.0 Sep 19, 2026
@sunnylqm
sunnylqm merged commit 908a23f into master Sep 19, 2026
6 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