Skip to content

新增国内用户升级版本帮助信息#431

Open
clenji wants to merge 5 commits intolarksuite:mainfrom
clenji:main
Open

新增国内用户升级版本帮助信息#431
clenji wants to merge 5 commits intolarksuite:mainfrom
clenji:main

Conversation

@clenji
Copy link
Copy Markdown

@clenji clenji commented Apr 12, 2026

使用国内网络环境的用户如何更稳定的实现cli更新

Summary by CodeRabbit

  • Documentation
    • Added a new “How to update/upgrade” section for the domestic (Chinese) release with a concise three-step upgrade flow: switch to a domestic npm registry, install the latest CLI release globally, and verify the installed version. Instructions sit alongside existing quick-start login/authentication examples.

clenji and others added 4 commits April 12, 2026 15:30
Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
Add instructions for updating lark-cli in README.zh.md
@github-actions github-actions bot added the size/S Low-risk docs, CI, test, or chore only changes label Apr 12, 2026
@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Apr 12, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 7666c539-83ff-434a-abe5-92db51e13e1c

📥 Commits

Reviewing files that changed from the base of the PR and between 65b3c50 and 1d90e06.

📒 Files selected for processing (1)
  • README.zh.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • README.zh.md

📝 Walkthrough

Walkthrough

Added a new "如何更新/升级(国内版)" section to README.zh.md with a three-step process: switch npm registry to a domestic mirror, globally install the latest @larksuite/cli, and verify the version.

Changes

Cohort / File(s) Summary
Documentation
README.zh.md
Inserted "How to Update/Upgrade (Domestic Version)" after the "快速开始(AI Agent)" login & auth example; provides three steps: set npm registry to https://registry.npmmirror.com, run npm install -g @larksuite/cli@latest, and verify with lark-cli --version. No deletions or other command modifications.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Suggested labels

size/M

Suggested reviewers

  • liangshuo-1
  • liuxinyanglxy

Poem

🐰 我是小兔来报捷,
文档添章三步接,
镜像切换装最新,
版本确认笑开怀,
更新路上不迷路 ✨

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description is incomplete and does not follow the provided template structure; it lacks Summary, Changes, Test Plan, and Related Issues sections. Restructure the description to match the template, adding Summary, Changes list, Test Plan checklist, and Related Issues sections.
✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main change: adding upgrade version help information for domestic users in the Chinese README.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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

@greptile-apps
Copy link
Copy Markdown

greptile-apps bot commented Apr 12, 2026

Greptile Summary

This PR adds a new ### 如何更新/升级(国内版) section to README.zh.md, providing a 3-step guide for domestic Chinese users to update lark-cli via the npmmirror.com registry. The content is accurate and logically placed within the existing installation section.

Confidence Score: 5/5

Safe to merge — documentation-only change with accurate content.

All findings are P2 style suggestions; no logic errors, security issues, or runtime breakage.

No files require special attention.

Important Files Changed

Filename Overview
README.zh.md Adds a 3-step domestic upgrade guide (npm mirror config → install latest → verify version); content is accurate and well-structured.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[国内用户需要升级 lark-cli] --> B[第 1 步: 设置淘宝镜像源]
    B --> C[第 2 步: 全局安装最新版本]
    C --> D[第 3 步: 验证版本]
    D --> E{版本已更新?}
    E -- 是 --> F[升级完成]
    E -- 否 --> B
Loading

Reviews (2): Last reviewed commit: "Update README.zh.md" | Re-trigger Greptile

Copy link
Copy Markdown

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 Nitpick comments (1)
README.zh.md (1)

133-136: Use scoped registry configuration to avoid affecting all npm packages globally.

Line 135: The current setting changes the global default registry for all packages, which can introduce unexpected side effects. Configure only the @larksuite scope instead.

📌 Suggested documentation change
-# 设置淘宝/阿里云镜像(加速下载)
-npm config set registry https://registry.npmmirror.com
+# 仅为 `@larksuite` 包设置镜像(避免影响其他 npm 包)
+npm config set `@larksuite`:registry https://registry.npmmirror.com
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@README.zh.md` around lines 133 - 136, Replace the global registry change
shown ("npm config set registry https://registry.npmmirror.com") with a scoped
registry configuration for the `@larksuite` scope so only packages under that
scope use the mirror; update the README to instruct setting the `@larksuite`
registry (and recommend using the project-level/location flag rather than
global) instead of changing the default for all npm packages.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@README.zh.md`:
- Around line 133-136: Replace the global registry change shown ("npm config set
registry https://registry.npmmirror.com") with a scoped registry configuration
for the `@larksuite` scope so only packages under that scope use the mirror;
update the README to instruct setting the `@larksuite` registry (and recommend
using the project-level/location flag rather than global) instead of changing
the default for all npm packages.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 295384e4-e832-48c6-8a10-e83a446b5089

📥 Commits

Reviewing files that changed from the base of the PR and between 0e7f507 and 65b3c50.

📒 Files selected for processing (1)
  • README.zh.md

Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size/S Low-risk docs, CI, test, or chore only changes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant