ci: add step to get changes in docs translation workflow #823
Conversation
总览演练此次更改涉及 GitHub 工作流文件和多个中文文档文件。在 变更
可能相关的 PR
诗歌
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
Documentation and Community
|
docs: add more content separation in about.md
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🔭 Outside diff range comments (1)
.github/workflows/docs-translate.yaml (1)
get_changes步骤的输出未被使用且工作流程配置可以优化工作流程已经通过
paths触发器限制了只在docs/**路径下的文件变更时才触发，但是：
get_changes步骤获取的变更信息 (steps.get_changes.outputs.changes) 在后续步骤中完全没有被使用- 使用了已弃用的
::set-output语法建议进行以下改进：
- 如果不需要变更信息，可以直接移除
Get Changes步骤- 如果确实需要使用变更信息来优化工作流程：
- 将
::set-output更新为新的$GITHUB_OUTPUT语法- 添加条件步骤，根据变更的文件类型执行不同的翻译任务
- 可以考虑只在
docs/index.md发生变更时才执行翻译示例改进语法：
- name: Get Changes id: get_changes run: | echo "changes=$(git diff-tree --no-commit-id --name-only -r HEAD)" >> $GITHUB_OUTPUT🔗 Analysis chain
Line range hint
19-73: 验证工作流程的完整性新增的变更检测步骤 (
Get Changes) 的输出似乎没有被后续步骤使用。运行以下脚本验证工作流程中是否有使用这个输出：
建议：
- 如果这个输出未被使用，请添加相应的条件步骤来利用这个信息
- 考虑添加条件执行，仅在文档文件发生更改时运行翻译
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # 描述：检查工作流程中是否使用了 get_changes 步骤的输出 # 搜索工作流程文件中使用 steps.get_changes 的地方 rg "steps.get_changes" .github/workflows/Length of output: 41
Script:
#!/bin/bash # 检查工作流程文件中的内容，查找是否有使用 changes 输出 rg "changes" .github/workflows/docs-translate.yaml # 检查是否有其他工作流程文件引用了这个输出 fd -e yaml -e yml . .github/workflows/ --exec cat {} \; | rg "changes" # 检查工作流程的触发条件 rg "on:" -A 10 .github/workflows/docs-translate.yamlLength of output: 1394
🧰 Tools
🪛 actionlint (1.7.4)
21-21: workflow command "set-output" was deprecated. use
echo "{name}={value}" >> $GITHUB_OUTPUTinstead: https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions(deprecated-commands)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (4)
.github/workflows/docs-translate.yaml(2 hunks)docs/zh-cn/guide/introduce/about.md(1 hunks)docs/zh-hk/guide/introduce/about.md(1 hunks)docs/zh-tw/guide/introduce/about.md(1 hunks)
✅ Files skipped from review due to trivial changes (3)
- docs/zh-cn/guide/introduce/about.md
- docs/zh-hk/guide/introduce/about.md
- docs/zh-tw/guide/introduce/about.md
🧰 Additional context used
🪛 actionlint (1.7.4)
.github/workflows/docs-translate.yaml
21-21: workflow command "set-output" was deprecated. use echo "{name}={value}" >> $GITHUB_OUTPUT instead: https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions
(deprecated-commands)
🔇 Additional comments (1)
.github/workflows/docs-translate.yaml (1)
71-73: 请确认英文文档翻译的状态
英文翻译步骤被注释掉可能会导致英文文档不同步。请确认：
- 这是否是有意为之？
- 是否计划在后续 PR 中重新启用？
如果这是临时更改，建议添加 TODO 注释说明原因和计划。
| - name: Get Changes | ||
| id: get_changes | ||
| run: | | ||
| echo "::set-output name=changes::$(git diff-tree --no-commit-id --name-only -r HEAD)" |
There was a problem hiding this comment.
需要更新已弃用的工作流命令语法
set-output 命令已被弃用，建议使用新的 GITHUB_OUTPUT 环境文件语法。
建议按照以下方式修改：
- name: Get Changes
id: get_changes
run: |
- echo "::set-output name=changes::$(git diff-tree --no-commit-id --name-only -r HEAD)"
+ echo "changes=$(git diff-tree --no-commit-id --name-only -r HEAD)" >> $GITHUB_OUTPUT📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| - name: Get Changes | |
| id: get_changes | |
| run: | | |
| echo "::set-output name=changes::$(git diff-tree --no-commit-id --name-only -r HEAD)" | |
| - name: Get Changes | |
| id: get_changes | |
| run: | | |
| echo "changes=$(git diff-tree --no-commit-id --name-only -r HEAD)" >> $GITHUB_OUTPUT |
🧰 Tools
🪛 actionlint (1.7.4)
21-21: workflow command "set-output" was deprecated. use echo "{name}={value}" >> $GITHUB_OUTPUT instead: https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions
(deprecated-commands)
…odify more tag in about.md
…ut; modify more tag in about.md
…es and modify more tag in about.md
…les and adjust more tag in about.md
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (3)
bin/doc-translate.js (1)
10-10: 通过环境变量获取变更文件列表的思路合理。
为确保健壮性，可在后续考虑在主逻辑中对ALL_CHANGED_FILES进行空值或异常场景的处理。.github/workflows/docs-translate.yaml (2)
27-35: 在控制台列出变更文件便于调试和核对，做法简洁清晰。
如需在后续步骤自动处理文件列表，建议同时将完整路径打印，以便排查问题。
84-85: 在后续步骤中传入ALL_CHANGED_FILES环境变量使翻译脚本可直接使用变更列表，逻辑顺畅。
也建议考虑对空列表或无变更文件的场景进行特殊处理，避免无必要的翻译任务。
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (5)
.github/workflows/docs-translate.yaml(2 hunks)bin/doc-translate.js(2 hunks)changes.txt(1 hunks)docs/zh-hk/guide/introduce/about.md(1 hunks)docs/zh-tw/guide/introduce/about.md(1 hunks)
✅ Files skipped from review due to trivial changes (1)
- changes.txt
🚧 Files skipped from review as they are similar to previous changes (2)
- docs/zh-tw/guide/introduce/about.md
- docs/zh-hk/guide/introduce/about.md
🔇 Additional comments (3)
bin/doc-translate.js (2)
4-4: 引入 process 模块已满足读取环境变量需求，逻辑上无问题。
建议后续仔细检查是否需要在其他环境（如本地调试、容器环境）中提供相应变量。
56-60: 跳过不在变更列表中的文件可提高效率，但需确认文件路径匹配规则是否精确。
若 ALL_CHANGED_FILES 仅包含文件名而未包含完整路径，可能导致匹配不准确，从而漏翻译或误跳过。
.github/workflows/docs-translate.yaml (1)
19-26: 成功引入新的步骤来获取变更文件列表，可有效减少不必要的翻译操作。
若需支持更多翻译场景，建议再进一步细化文件匹配策略。
…ify more tag in about.md
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (6)
docs/en/components/model-morph-addon.md (1)
Line range hint
48-61: 多态关系映射实现优化！代码示例展示了更好的实现方式：
- 使用
getActualClassNameForMorph方法在模型内部管理映射关系，避免了全局配置- 通过
getMorphClass方法明确定义每个模型的多态标识符这种实现方式的优势：
- 提高了代码的内聚性
- 使多态关系的配置更加明确和易于维护
- 避免了全局状态可能带来的问题
Also applies to: 71-74, 84-87
.github/workflows/docs-translate.yaml (3)
19-27: 工作流改进建议：文件匹配模式可以优化当前的文件匹配模式存在重复：
files: | **.md docs/**.md建议简化为单一模式：
files: docs/**.md这样可以：
- 更精确地只匹配 docs 目录下的 markdown 文件
- 避免不必要的文件匹配
28-35: 建议优化文件变更日志输出格式当前的文件列表输出格式可以改进以提供更多有用信息。建议：
- 添加时间戳
- 包含文件的变更类型（新增/修改/删除）
- 使用结构化的输出格式
- for file in ${ALL_CHANGED_FILES}; do - echo "$file was changed" - done + echo "检测到以下文件发生变更 ($(date '+%Y-%m-%d %H:%M:%S')):" + for file in ${ALL_CHANGED_FILES}; do + echo "- $file ($(git status --porcelain "$file" | cut -c1-2))" + done
85-87: 优化条件执行逻辑建议将环境变量设置和条件判断合并到一起，使工作流更清晰：
- if: steps.changed-markdown-files.outputs.any_changed == 'true' - env: - ALL_CHANGED_FILES: ${{ steps.changed-markdown-files.outputs.all_changed_files }} + if: steps.changed-markdown-files.outputs.any_changed == 'true' + env: + ALL_CHANGED_FILES: ${{ steps.changed-markdown-files.outputs.all_changed_files }} + CHANGED_STATUS: 'true'docs/en/components/compoships.md (1)
3-3: 文档改进建议文档的整体改进很好，但有以下几点建议：
- 第40行需要添加逗号以提高可读性：
- If for some reason you cannot extend your model from + If, for some reason, you cannot extend your model from
建议在安装说明部分添加版本要求信息，帮助用户了解兼容性要求。
示例代码部分建议添加更多注释，特别是对多列关系的解释。
Also applies to: 7-7, 26-26, 40-40, 110-110
docs/en/components/model-hashids.md (1)
136-136: 路由绑定说明更完整添加了关于路由解析过程的重要细节，并提供了具体的路由配置示例。建议添加一个完整的工作示例来展示整个流程。
Also applies to: 161-161
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (30)
.github/workflows/docs-translate.yaml(2 hunks)docs/en/components/amqp-job.md(1 hunks)docs/en/components/command-signals.md(1 hunks)docs/en/components/command-validation.md(1 hunks)docs/en/components/compoships.md(4 hunks)docs/en/components/config-consul.md(1 hunks)docs/en/components/console-spinner.md(2 hunks)docs/en/components/fast-paginate.md(2 hunks)docs/en/components/http-client.md(1 hunks)docs/en/components/http-logger.md(1 hunks)docs/en/components/lock.md(1 hunks)docs/en/components/model-hashids.md(8 hunks)docs/en/components/model-morph-addon.md(1 hunks)docs/en/components/model-observer.md(1 hunks)docs/en/components/notification-easysms.md(1 hunks)docs/en/components/notification-mail.md(2 hunks)docs/en/components/notification.md(3 hunks)docs/en/components/purifier.md(1 hunks)docs/en/components/redis-subscriber.md(1 hunks)docs/en/components/sentry.md(2 hunks)docs/en/components/tcp-sender.md(1 hunks)docs/en/components/telescope-elasticsearch.md(1 hunks)docs/en/components/validated-dto.md(8 hunks)docs/en/components/web-tinker.md(1 hunks)docs/en/guide/introduce/about.md(1 hunks)docs/en/guide/start/components.md(1 hunks)docs/en/index.md(2 hunks)docs/zh-cn/guide/introduce/about.md(1 hunks)docs/zh-hk/guide/introduce/about.md(1 hunks)docs/zh-tw/guide/introduce/about.md(1 hunks)
✅ Files skipped from review due to trivial changes (19)
- docs/en/guide/introduce/about.md
- docs/en/components/web-tinker.md
- docs/en/components/config-consul.md
- docs/en/components/model-observer.md
- docs/en/components/notification-easysms.md
- docs/en/components/amqp-job.md
- docs/en/components/telescope-elasticsearch.md
- docs/en/components/console-spinner.md
- docs/en/components/purifier.md
- docs/en/components/notification-mail.md
- docs/en/components/http-logger.md
- docs/en/index.md
- docs/en/guide/start/components.md
- docs/en/components/fast-paginate.md
- docs/en/components/command-validation.md
- docs/en/components/tcp-sender.md
- docs/en/components/sentry.md
- docs/en/components/http-client.md
- docs/en/components/validated-dto.md
🚧 Files skipped from review as they are similar to previous changes (3)
- docs/zh-tw/guide/introduce/about.md
- docs/zh-cn/guide/introduce/about.md
- docs/zh-hk/guide/introduce/about.md
🧰 Additional context used
🪛 LanguageTool
docs/en/components/compoships.md
[typographical] ~40-~40: Consider wrapping this idiom with two commas if you want to put a strong emphasize on it.
Context: ...fHyperf\Compoships\ComposhipsTrait If for some reason you cannot extend your model fromFrie...
(FOR_WHATEVER_REASON_COMMA)
🔇 Additional comments (9)
docs/en/components/command-signals.md (1)
52-52: 指令说明更新清晰明确！
命令终止的说明更新得更加简洁和专业，使用更标准的技术表述。
Also applies to: 59-59
docs/en/components/model-morph-addon.md (1)
3-3: 术语更新更符合技术规范！
将"polymorphic associations"更新为"polymorphic relationships"更符合Laravel/Hyperf生态系统中的标准术语。
docs/en/components/lock.md (1)
33-33: 锁机制文档说明更清晰！
文档更新改进：
- 更清晰地说明了锁的自动释放机制
- 优化了等待时间的描述，使技术细节更准确
这些改进使文档更容易理解和使用。
Also applies to: 41-41
docs/en/components/redis-subscriber.md (1)
5-5: 文档改进清晰且准确！
文档的修改提高了可读性，同时保持了技术内容的准确性。修改包括：
- 更准确地描述了基于 Swoole 协程的实现
- 优化了功能描述的表述方式
- 保持了技术细节的完整性
Also applies to: 8-9
docs/en/components/model-hashids.md (3)
5-5: 文档表述更准确
将数据库列的描述从复数改为单数，并使用更恰当的性能描述词汇，使文档更加准确。
45-45: 配置说明更清晰
重写了自定义 hashid 设置的说明，使配置步骤更容易理解。
173-173: 功能支持说明更全面
明确说明了对软删除和子路由绑定的支持，这对用户理解功能范围很有帮助。
docs/en/components/notification.md (2)
21-22: 导入语句格式优化
将 use 语句分开写，提高了代码的可读性。
241-241: 章节标题更规范
将"Using in Controller"改为"Using in a Controller"，使英文表达更加规范。
Summary by CodeRabbit