Skip to content

fix: restore docker packaging docs for releases#48

Merged
vansour merged 2 commits intomainfrom
release/v0.1.3-rc.12
Apr 20, 2026
Merged

fix: restore docker packaging docs for releases#48
vansour merged 2 commits intomainfrom
release/v0.1.3-rc.12

Conversation

@vansour
Copy link
Copy Markdown
Owner

@vansour vansour commented Apr 20, 2026

Summary

  • restore the docker packaging README consumed by the release workflow
  • unblock rginx-web release archive packaging for prerelease tags

Validation

  • fixed by matching the existing package step path in .github/workflows/release.yml

Copilot AI review requested due to automatic review settings April 20, 2026 11:40
@chatgpt-codex-connector
Copy link
Copy Markdown

You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard.

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 20, 2026

Warning

Rate limit exceeded

@vansour has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 22 minutes and 17 seconds before requesting another review.

Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 22 minutes and 17 seconds.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Repository UI (base), Organization UI (inherited)

Review profile: CHILL

Plan: Pro

Run ID: 5eaf1755-d186-4292-ab0d-34b3160b7eb5

📥 Commits

Reviewing files that changed from the base of the PR and between ab5af0f and 7c1d95c.

📒 Files selected for processing (1)
  • docker/README.md
📝 Walkthrough

演练

添加了 docker/README.md 文件,包含 rginx-web 容器化发布包的文档说明,介绍了包含的文件、快速启动步骤、镜像引用格式以及运行时注意事项。

变更

内聚组 / 文件 摘要
容器化文档
docker/README.md
新增容器包装文档,说明了发布包内容(compose.yaml、.env.example、README 及前端资源)、快速启动工作流(.env 配置及启动命令)、控制平面镜像引用格式、运行时注意事项(包括非 Compose 用法的环境变量配置)及对 Compose 包范围的说明。

预估代码审查工作量

🎯 1 (Trivial) | ⏱️ ~3 分钟

一份新文档悄然诞生,
Docker 容器的使用指引展开,
快速启动只需几行配置,
从 .env 到 compose 一切就绪,
🐰 为部署之路添一盏灯。

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main change: restoring the docker packaging documentation file that was missing, which directly aligns with the changeset adding docker/README.md.
Description check ✅ Passed The description is clearly related to the changeset, explaining the purpose of restoring the docker packaging README and how it unblocks the release workflow.
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
  • Commit unit tests in branch release/v0.1.3-rc.12

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 and usage tips.

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.

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@docker/README.md`:
- Around line 17-20: Update the Quick Start sequence so it forces updating
sensitive defaults before launching: after the cp .env.example .env step, add a
clear instruction/warning telling users to change the placeholder secrets and
list the specific env variables to update (RGINX_CONTROL_AUTH_SESSION_SECRET,
RGINX_CONTROL_AGENT_SHARED_TOKEN, RGINX_CONTROL_BOOTSTRAP_ADMIN_PASSWORD) and
only then run docker compose --env-file .env up -d; ensure the README text
emphasizes these are required security changes and not optional, and include the
sample admonition from the review so new users don’t start with default weak
credentials.
- Around line 26-28: 说明文档里描述 compose.yaml 会“挂载前端静态资源目录”与实际不符:compose.yaml 中的
rginx-web 服务未配置该挂载且未说明镜像可能不包含 UI 资源,导致在未设置 RGINX_CONTROL_UI_DIR 时 UI 可能不可用。请更新
README 中关于 compose.yaml 和 rginx-web 的描述,明确写成“compose.yaml 启动控制面容器,但 rginx-web
并不默认挂载本地前端目录;若镜像未内置 UI 静态资源,需要在 compose 或单独运行 rginx-web 时显式挂载 control-console/
并设置环境变量 RGINX_CONTROL_UI_DIR 指向该目录(否则 UI 无法使用)”,并保留 control-console/ 与
RGINX_CONTROL_UI_DIR 作为示例引用以便定位修改位置。
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Repository UI (base), Organization UI (inherited)

Review profile: CHILL

Plan: Pro

Run ID: 1ca3e804-fe7b-419e-bb01-3245e45d4cfb

📥 Commits

Reviewing files that changed from the base of the PR and between 4b81c6e and ab5af0f.

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

Comment thread docker/README.md
Comment thread docker/README.md Outdated
Copy link
Copy Markdown

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

Restores the docker/README.md documentation file that the release workflow packages into rginx-web release archives, to support Docker/Compose-based control-plane distribution.

Changes:

  • Add docker/README.md back under docker/ to be included in release artifacts.
  • Document the intended contents of the rginx-web release archive and basic startup steps.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread docker/README.md
Comment thread docker/README.md Outdated
@vansour vansour merged commit 764c08e into main Apr 20, 2026
7 checks passed
@vansour vansour deleted the release/v0.1.3-rc.12 branch April 20, 2026 12:22
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.

2 participants