Skip to content

docs: 在 uv 部署文档中添加不支持 WebUI 升级的说明#7298

Merged
RC-CHN merged 7 commits intoAstrBotDevs:masterfrom
piexian:docs/uv-deploy-warning
Apr 3, 2026
Merged

docs: 在 uv 部署文档中添加不支持 WebUI 升级的说明#7298
RC-CHN merged 7 commits intoAstrBotDevs:masterfrom
piexian:docs/uv-deploy-warning

Conversation

@piexian
Copy link
Copy Markdown
Contributor

@piexian piexian commented Apr 2, 2026

通过 astrbot run(CLI 模式)启动时,会设置 ASTRBOT_CLI 环境变量,
updator 会拒绝 WebUI 触发的升级操作以避免版本管理混乱。
用户需要通过命令行执行 uv tool upgrade astrbot 来更新。

Closes #7291

Modifications / 改动点

在 uv 部署相关文档中增加了 WebUI 不支持升级的警告说明,涉及以下文件:

  • docs/zh/deploy/astrbot/package.md — 中文部署文档,新增「注意事项」章节
  • docs/en/deploy/astrbot/package.md — 英文部署文档,新增「Important Notes」章节
  • README.md / README_zh.md / README_zh-TW.md / README_ja.md / README_fr.md / README_ru.md — 各语言 README 的 uv 升级命令后追加 WARNING 提示

本次改动仅涉及文档,不涉及代码逻辑变更。

  • This is NOT a breaking change. / 这不是一个破坏性变更。

Screenshots or Test Results / 运行截图或测试结果


Checklist / 检查清单

  • 😊 If there are new features added in the PR, I have discussed it with the authors through issues/emails, etc.
    / 如果 PR 中有新加入的功能,已经通过 Issue / 邮件等方式和作者讨论过。

  • 👀 My changes have been well-tested, and "Verification Steps" and "Screenshots" have been provided above.
    / 我的更改经过了良好的测试,并已在上方提供了“验证步骤”和“运行截图”

  • 🤓 I have ensured that no new dependencies are introduced, OR if new dependencies are introduced, they have been added to the appropriate locations in requirements.txt and pyproject.toml.
    / 我确保没有引入新依赖库,或者引入了新依赖库的同时将其添加到 requirements.txtpyproject.toml 文件相应位置。

  • 😮 My changes do not introduce malicious code.
    / 我的更改没有引入恶意代码。

Summary by Sourcery

Document the limitation that AstrBot deployed via uv cannot be upgraded through the WebUI and must be updated via the uv tool upgrade astrbot CLI command.

Documentation:

  • Add an "Important Notes" section to the English uv deployment guide explaining that uv deployments cannot be upgraded via WebUI and must use the CLI upgrade command.
  • Add a corresponding "注意事项" section to the Chinese uv deployment guide describing the same WebUI upgrade limitation and CLI-based update process.
  • Append warning notes after the uv upgrade command in all localized READMEs to clarify that uv deployments do not support WebUI-based upgrades and should be updated from the command line.

通过 astrbot run(CLI 模式)启动时,会设置 ASTRBOT_CLI 环境变量,
updator 会拒绝 WebUI 触发的升级操作以避免版本管理混乱。
用户需要通过命令行执行 uv tool upgrade astrbot 来更新。

Closes AstrBotDevs#7291
Copilot AI review requested due to automatic review settings April 2, 2026 12:56
@auto-assign auto-assign bot requested review from Fridemn and advent259141 April 2, 2026 12:56
@dosubot dosubot bot added the size:S This PR changes 10-29 lines, ignoring generated files. label Apr 2, 2026
Copy link
Copy Markdown
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey - I've reviewed your changes and they look great!


Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request adds a warning to the README files and deployment documentation in multiple languages, informing users that AstrBot instances deployed via uv cannot be upgraded through the WebUI and must be updated via the command line. Feedback was provided to bold the warning text in the README files to ensure consistency with the detailed documentation and to improve visibility for users.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR updates the uv deployment documentation to clearly warn users that AstrBot installed/deployed via uv cannot be upgraded through the WebUI, and that upgrades must be performed via uv tool upgrade astrbot from the command line (addressing #7291).

Changes:

  • Add a prominent WARNING admonition to multiple localized READMEs near the uv tool upgrade astrbot command.
  • Add a new “Important Notes / 注意事项” section to the uv package-manager deployment docs (EN/ZH) with the same warning.

Reviewed changes

Copilot reviewed 8 out of 8 changed files in this pull request and generated no comments.

Show a summary per file
File Description
README.md Adds a WARNING block explaining WebUI upgrades aren’t supported for uv deployments.
README_zh.md Adds the same WARNING in Simplified Chinese.
README_zh-TW.md Adds the same WARNING in Traditional Chinese.
README_ru.md Adds the same WARNING in Russian.
README_ja.md Adds the same WARNING in Japanese.
README_fr.md Adds the same WARNING in French.
docs/zh/deploy/astrbot/package.md Adds a “注意事项” section with a WARNING about WebUI upgrades for uv deployments.
docs/en/deploy/astrbot/package.md Adds an “Important Notes” section with the same WARNING.

LIghtJUNction and others added 6 commits April 2, 2026 22:21
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
@dosubot dosubot bot added the lgtm This PR has been approved by a maintainer label Apr 3, 2026
@RC-CHN RC-CHN merged commit 88d70a8 into AstrBotDevs:master Apr 3, 2026
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

lgtm This PR has been approved by a maintainer size:S This PR changes 10-29 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

uv部署版本过于老旧

4 participants