feat(base): optimize workflow skills#345
Merged
yballul-bytedance merged 1 commit intomainfrom Apr 10, 2026
Merged
Conversation
github-actions
Bot
added
domain/base
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
📝 WalkthroughWalkthroughRemoved documentation of file-based Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
Greptile SummaryThis PR adds a new
Confidence Score: 4/5Safe to merge after resolving the jsonInputTip contradiction; documentation content is high quality. One P1 finding: the CLI error tip in base_shortcut_helpers.go still advertises --json @filename, actively contradicting the new docs prohibition. All other changes are documentation-only with clear, well-structured content. The P1 issue is straightforward to fix (update jsonInputTip to remove the @file hint). shortcuts/base/workflow_create.go and workflow_update.go — inherited jsonInputTip message contradicts new @filename prohibition. Important Files Changed
Flowchart%%{init: {'theme': 'neutral'}}%%
flowchart TD
A[Agent reads workflow-create.md] --> B["Rule: prohibit --json @filename"]
B --> C[Agent sends malformed JSON to CLI]
C --> D["CLI: parseJSONObject → formatJSONError"]
D --> E["jsonInputTip: 'use --json @path/to/file.json'"]
E --> F["❌ Agent sees CLI tip contradicting doc rule"]
G[Agent reads workflow-guide.md] --> H["5 runnable JSON examples"]
H --> I["Top-10 error avoidance table"]
I --> J["Field-value quick reference"]
J --> K["✅ Agent constructs workflow correctly"]
Reviews (8): Last reviewed commit: "feat: workflow 相关 skill 优化" | Re-trigger Greptile |
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
🚀 PR Preview Install Guide🧰 CLI updatenpm i -g https://pkg.pr.new/larksuite/cli/@larksuite/cli@90a20faa28a468f446780f4dcc0d26f1d5974d5e🧩 Skill updatenpx skills add larksuite/cli#feat/workflow_skill_opt -y -g |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 6
🧹 Nitpick comments (3)
skills/lark-base/references/lark-base-workflow-create.md (1)
31-31: Example payload should avoidchildrenon Trigger/Action nodes.This sample currently adds
children: {"links":[]}toAddRecordTriggerandLarkMessageAction, which conflicts with the schema guidance (“Trigger/Action 节点请勿设置children”). Prefer removing those fields in this basic create example.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@skills/lark-base/references/lark-base-workflow-create.md` at line 31, The example payload includes extraneous children fields on nodes which conflicts with the schema; remove the children property from both the AddRecordTrigger node ("type":"AddRecordTrigger") and the LarkMessageAction node ("type":"LarkMessageAction") in the JSON string so the sample uses only the required fields (id, type, title, next, data, etc.) and no children: {"links":[]} entries.skills/lark-base/references/lark-base-workflow-list.md (1)
107-110: Clarify bullet nesting in the “不需要先 list” section.
**❌ 不需要先 list 的场景**is currently indented as part of the previous bullet, which can render as nested content. Move it to top-level for clearer structure.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@skills/lark-base/references/lark-base-workflow-list.md` around lines 107 - 110, The header "**❌ 不需要先 list 的场景**" is currently nested under the previous bullet; move it to top-level by removing the leading indentation and ensuring there is a blank line before it so it renders as a standalone heading, and keep its child bullets ("创建工作流：直接调用 `+workflow-create`..." and "查看指定工作流详情：如果已知 workflow_id，直接 `+workflow-get`") directly beneath it as its list items.skills/lark-base/references/lark-base-workflow-update.md (1)
14-15: 建议统一链接文案与实际文件名，降低检索成本。当前链接文本是
workflow-guide.md/workflow-schema.md，目标文件是lark-base-workflow-guide.md/lark-base-workflow-schema.md。可读性上建议保持一致。🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@skills/lark-base/references/lark-base-workflow-update.md` around lines 14 - 15, Update the markdown link texts in lark-base-workflow-update.md so they match the actual target filenames: replace the displayed link text "workflow-guide.md" with "lark-base-workflow-guide.md" and "workflow-schema.md" with "lark-base-workflow-schema.md", ensuring the Markdown links remain valid and point to the existing files (refer to the current lines that contain the two links mentioning Loop/IfElseBranch/SwitchBranch and the schema reference).
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@shortcuts/base/workflow_create.go`:
- Line 22: The CLI now claims --json accepts inline JSON only, but the command
still uses loadJSONInput (shortcuts/base/base_shortcut_helpers.go) which allows
`@file`; enforce inline-only by rejecting file-prefixed inputs in the workflow
create command's Validate, DryRun, and Execute methods (the same call paths that
currently call loadJSONInput) — implement a small helper (e.g.,
loadInlineJSONInput) that returns an error if the input starts with '@' and use
it from Validate, DryRun, and Execute (or add the guard at the start of each of
those methods) so behavior matches the help text.
In `@shortcuts/base/workflow_update.go`:
- Line 23: The help text was changed to disallow file-style inputs but the
runtime still accepts them via loadJSONInput/parseJSONObject; update the runtime
to reject inputs that start with '@' for this command by adding a guard in
BaseWorkflowUpdate (or in the command-specific caller before calling
loadJSONInput/parseJSONObject) that checks the "json" argument and returns an
error if it begins with '@', ensuring file-based JSON (e.g. `@path`) is refused at
runtime rather than only in docs.
In `@skills/lark-base/references/lark-base-workflow-guide.md`:
- Around line 59-63: The table's in-page anchor links (e.g., the fragments
referenced for 示例1-新增记录触发--发送消息, 示例2-定时触发--查找记录--循环遍历--发送消息,
示例3-条件分支-ifelsebranch, 示例4-多路分支-switchbranch, 示例5-组合场景-定时查找循环分支消息) do not match
the actual generated Markdown heading IDs and trigger MD051; update each
fragment target in the table to the exact slugified heading ID used by the
renderer (open the headings in the same file to copy their generated anchor IDs
or run your Markdown slugifier), replacing the current fragments with the
correct ones so the links resolve.
- Around line 670-671: The rule saying "所有步骤都必须有 `children`" conflicts with the
schema — update the text to state that `children` is optional per schema and
that only container/compound workflow nodes (e.g., step groups or branching
nodes) should include `children: {"links":[]}`, while terminal node types like
`Trigger` and `Action` must not set `children`; also adjust the guidance around
`IfElseBranch`/`SwitchBranch` unchanged but ensure the example references
`IfElseBranch` and `SwitchBranch` consistently with the schema.
- Line 39: The examples use an invalid enum for the receive_scene field
("user"); replace each occurrence of "receive_scene": "user" with the correct
schema enum value ("group" or "chat") as appropriate to the example context so
the payloads validate; search for the receive_scene field in the document (all
listed occurrences) and update the string values to "group" or "chat" to match
the schema.
In `@skills/lark-base/references/lark-base-workflow-update.md`:
- Line 34: Update the `--json <body>` parameter description to accurately
reflect the accepted workflow JSON fields instead of saying "包含 `title` 和/或
`steps`": state that it accepts the workflow body as JSON which may include
`title`, `steps`, `user_id_type`, and other optional fields as defined in the
API field section, and make the wording consistent with the later mention of
`user_id_type` (ensure both the `--json <body>` row and the API field list use
the same phrasing).
---
Nitpick comments:
In `@skills/lark-base/references/lark-base-workflow-create.md`:
- Line 31: The example payload includes extraneous children fields on nodes
which conflicts with the schema; remove the children property from both the
AddRecordTrigger node ("type":"AddRecordTrigger") and the LarkMessageAction node
("type":"LarkMessageAction") in the JSON string so the sample uses only the
required fields (id, type, title, next, data, etc.) and no children:
{"links":[]} entries.
In `@skills/lark-base/references/lark-base-workflow-list.md`:
- Around line 107-110: The header "**❌ 不需要先 list 的场景**" is currently nested
under the previous bullet; move it to top-level by removing the leading
indentation and ensuring there is a blank line before it so it renders as a
standalone heading, and keep its child bullets ("创建工作流：直接调用
`+workflow-create`..." and "查看指定工作流详情：如果已知 workflow_id，直接 `+workflow-get`")
directly beneath it as its list items.
In `@skills/lark-base/references/lark-base-workflow-update.md`:
- Around line 14-15: Update the markdown link texts in
lark-base-workflow-update.md so they match the actual target filenames: replace
the displayed link text "workflow-guide.md" with "lark-base-workflow-guide.md"
and "workflow-schema.md" with "lark-base-workflow-schema.md", ensuring the
Markdown links remain valid and point to the existing files (refer to the
current lines that contain the two links mentioning
Loop/IfElseBranch/SwitchBranch and the schema reference).
🪄 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: defaults
Review profile: CHILL
Plan: Pro
Run ID: 9cf14da0-d32e-458e-a91e-85860d218cdb
📒 Files selected for processing (9)
shortcuts/base/workflow_create.goshortcuts/base/workflow_update.goskills/lark-base/SKILL.mdskills/lark-base/references/lark-base-workflow-create.mdskills/lark-base/references/lark-base-workflow-get.mdskills/lark-base/references/lark-base-workflow-guide.mdskills/lark-base/references/lark-base-workflow-list.mdskills/lark-base/references/lark-base-workflow-schema.mdskills/lark-base/references/lark-base-workflow-update.md
yballul-bytedance
force-pushed
the
feat/workflow_skill_opt
branch
from
966e244 to
150cdfe
Compare
There was a problem hiding this comment.
Actionable comments posted: 1
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
skills/lark-base/references/lark-base-workflow-update.md (1)
84-95:⚠️ Potential issue | 🟠 Major示例里给 Trigger/Action 增加
children会误导结构约束。Line 84 和 Line 95 在
AddRecordTrigger/LarkMessageAction上示例化children，与本 PR 的 workflow-guide 规则（仅 Branch/Loop 需要children）冲突，容易让用户构造出不必要或错误的 payload。✏️ Suggested fix
{ "id": "trigger_1", "type": "AddRecordTrigger", "title": "监控新订单", - "children": { "links": [] }, "next": "action_1", "data": { "table_name": "订单表", "watched_field_name": "订单号" } }, { "id": "action_1", "type": "LarkMessageAction", "title": "发送通知", - "children": { "links": [] }, "next": null, "data": {🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@skills/lark-base/references/lark-base-workflow-update.md` around lines 84 - 95, The examples incorrectly show a children property on non-composite nodes, specifically the AddRecordTrigger and LarkMessageAction examples, which conflicts with the workflow-guide rule that only Branch and Loop nodes should have children; remove the children fields from the AddRecordTrigger and LarkMessageAction examples so the payloads no longer include children for these node types and ensure only Branch/Loop examples show children in the documentation.
♻️ Duplicate comments (2)
skills/lark-base/references/lark-base-workflow-update.md (1)
34-34:⚠️ Potential issue | 🟡 Minor
--json参数说明仍然过窄。Line 34 仍写“包含
title和/或steps”，但同页 Line 70 已说明可传user_id_type。建议统一为“支持 API 字段定义中的可选字段”。🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@skills/lark-base/references/lark-base-workflow-update.md` at line 34, 更新 `--json <body>` 参数说明：将“包含 `title` 和/或 `steps`”改为更泛的描述（例如“支持 API 字段定义中的可选字段”），并确保与同文件中关于 `user_id_type` 的说明保持一致；在文档项 `--json <body>` 中统一措辞，表明可以包含 API 文档里所有可选字段（如 title、steps、user_id_type 等），以避免前后矛盾。skills/lark-base/references/lark-base-workflow-guide.md (1)
58-62:⚠️ Potential issue | 🟡 Minor场景速查表的锚点片段仍可能无法命中对应标题。
Line 58-Line 62 这组
#...片段与实际标题 slug 仍存在不一致风险（MD051）。请按渲染器生成的真实 heading ID 更新。🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@skills/lark-base/references/lark-base-workflow-guide.md` around lines 58 - 62, The anchor links in the quick-reference table (e.g., [下方](`#示例1-新增记录触发--发送消息`), [下方](`#示例2-定时触发--查找记录--循环遍历--发送消息`), [下方](`#示例3-条件分支-ifelsebranch`), [下方](`#示例4-多路分支-switchbranch`), [下方](`#示例5-组合场景-定时查找循环分支消息`)) do not match the actual rendered heading IDs (MD051); open the rendered HTML or run your markdown renderer to get the exact heading slugs and replace each table link target with the renderer-generated heading ID for the corresponding section (示例1…示例5) so the anchors resolve correctly.
🧹 Nitpick comments (1)
skills/lark-base/references/lark-base-workflow-guide.md (1)
647-647: 文案可读性微调：建议“3 路及以上”。Line 647 的“3路及以上”建议改成“3 路及以上”，阅读更自然。
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@skills/lark-base/references/lark-base-workflow-guide.md` at line 647, 将文案中的“3路及以上”改为“3 路及以上”以提高可读性；在文件 lark-base-workflow-guide.md 中找到包含文本“3路及以上”的位置（当前为原文第647行）并替换为“3 路及以上”，保持其余上下文不变。
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@skills/lark-base/references/lark-base-workflow-list.md`:
- Around line 111-112: The markdown uses '---' immediately after a sentence
which is being parsed as a Setext header (triggering MD003); update the section
that mentions `+workflow-list` so there is a blank line between the paragraph
and the `---` divider (or replace `---` with `***`) to ensure it's treated as a
horizontal rule rather than a Setext heading.
---
Outside diff comments:
In `@skills/lark-base/references/lark-base-workflow-update.md`:
- Around line 84-95: The examples incorrectly show a children property on
non-composite nodes, specifically the AddRecordTrigger and LarkMessageAction
examples, which conflicts with the workflow-guide rule that only Branch and Loop
nodes should have children; remove the children fields from the AddRecordTrigger
and LarkMessageAction examples so the payloads no longer include children for
these node types and ensure only Branch/Loop examples show children in the
documentation.
---
Duplicate comments:
In `@skills/lark-base/references/lark-base-workflow-guide.md`:
- Around line 58-62: The anchor links in the quick-reference table (e.g.,
[下方](`#示例1-新增记录触发--发送消息`), [下方](`#示例2-定时触发--查找记录--循环遍历--发送消息`),
[下方](`#示例3-条件分支-ifelsebranch`), [下方](`#示例4-多路分支-switchbranch`),
[下方](`#示例5-组合场景-定时查找循环分支消息`)) do not match the actual rendered heading IDs
(MD051); open the rendered HTML or run your markdown renderer to get the exact
heading slugs and replace each table link target with the renderer-generated
heading ID for the corresponding section (示例1…示例5) so the anchors resolve
correctly.
In `@skills/lark-base/references/lark-base-workflow-update.md`:
- Line 34: 更新 `--json <body>` 参数说明：将“包含 `title` 和/或 `steps`”改为更泛的描述（例如“支持 API
字段定义中的可选字段”），并确保与同文件中关于 `user_id_type` 的说明保持一致；在文档项 `--json <body>` 中统一措辞，表明可以包含
API 文档里所有可选字段（如 title、steps、user_id_type 等），以避免前后矛盾。
---
Nitpick comments:
In `@skills/lark-base/references/lark-base-workflow-guide.md`:
- Line 647: 将文案中的“3路及以上”改为“3 路及以上”以提高可读性；在文件 lark-base-workflow-guide.md
中找到包含文本“3路及以上”的位置（当前为原文第647行）并替换为“3 路及以上”，保持其余上下文不变。
🪄 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: defaults
Review profile: CHILL
Plan: Pro
Run ID: 92beb719-3888-413a-9c8a-1d3ff556c162
📒 Files selected for processing (9)
shortcuts/base/workflow_create.goshortcuts/base/workflow_update.goskills/lark-base/SKILL.mdskills/lark-base/references/lark-base-workflow-create.mdskills/lark-base/references/lark-base-workflow-get.mdskills/lark-base/references/lark-base-workflow-guide.mdskills/lark-base/references/lark-base-workflow-list.mdskills/lark-base/references/lark-base-workflow-schema.mdskills/lark-base/references/lark-base-workflow-update.md
✅ Files skipped from review due to trivial changes (5)
- skills/lark-base/references/lark-base-workflow-get.md
- shortcuts/base/workflow_create.go
- shortcuts/base/workflow_update.go
- skills/lark-base/references/lark-base-workflow-schema.md
- skills/lark-base/references/lark-base-workflow-create.md
🚧 Files skipped from review as they are similar to previous changes (1)
- skills/lark-base/SKILL.md
|
Tip: Greploop — Automatically fix all review issues by running Use the Greptile plugin for Claude Code to query reviews, search comments, and manage custom context directly from your terminal. |
yballul-bytedance
force-pushed
the
feat/workflow_skill_opt
branch
from
150cdfe to
2c9ef25
Compare
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (1)
skills/lark-base/references/lark-base-workflow-guide.md (1)
58-62:⚠️ Potential issue | 🟡 Minor修复目录锚点与标题 slug 的不一致。
Line 58-62 的片段链接仍与标题 slug 不匹配（例如标题是“示例 1...”，链接写成了
#示例1...）。这会导致目录跳转失效。🔧 建议修改
-| 新增触发+通知 | AddRecordTrigger → LarkMessageAction | [下方](`#示例1-新增记录触发--发送消息`) | -| 定时+循环 | TimerTrigger → FindRecordAction → Loop → LarkMessageAction | [下方](`#示例2-定时触发--查找记录--循环遍历--发送消息`) | -| 条件判断 | ... → IfElseBranch → 分支处理 | [下方](`#示例3-条件分支-ifelsebranch`) | -| 多路分类 | ... → SwitchBranch → 多分支处理 | [下方](`#示例4-多路分支-switchbranch`) | -| 复杂组合 | 定时+查找+循环+分支+消息 | [下方](`#示例5-组合场景-定时查找循环分支消息`) | +| 新增触发+通知 | AddRecordTrigger → LarkMessageAction | [下方](`#示例-1-新增记录触发--发送消息`) | +| 定时+循环 | TimerTrigger → FindRecordAction → Loop → LarkMessageAction | [下方](`#示例-2-定时触发--查找记录--循环遍历--发送消息`) | +| 条件判断 | ... → IfElseBranch → 分支处理 | [下方](`#示例-3-条件分支ifelsebranch`) | +| 多路分类 | ... → SwitchBranch → 多分支处理 | [下方](`#示例-4-多路分支switchbranch`) | +| 复杂组合 | 定时+查找+循环+分支+消息 | [下方](`#示例-5-组合场景定时查找循环分支消息`) |🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@skills/lark-base/references/lark-base-workflow-guide.md` around lines 58 - 62, The table links use anchor slugs like "#示例1-新增记录触发--发送消息" that don't match the actual heading slugs (which include spacing/punctuation), causing broken TOC links; update each link to the exact heading slug used in the document so they match the headings referenced (fix the five entries referencing "示例1-新增记录触发--发送消息", "示例2-定时触发--查找记录--循环遍历--发送消息", "示例3-条件分支-ifelsebranch", "示例4-多路分支-switchbranch", and "示例5-组合场景-定时查找循环分支消息") — ensure spacing, hyphens and casing exactly match the generated slug format (or URL-encode characters) so the anchors resolve correctly.
🧹 Nitpick comments (1)
skills/lark-base/references/lark-base-workflow-guide.md (1)
647-647: 文案建议：补充量词以提升可读性。Line 647 的“3路及以上”建议改为“3 路及以上”或“3 个分支及以上”。
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@skills/lark-base/references/lark-base-workflow-guide.md` at line 647, Replace the ambiguous phrase "3路及以上" (exact string) with a clearer wording such as "3 路及以上" or "3 个分支及以上" in the document text to improve readability; update the occurrence of "适合多路分类（3路及以上）" accordingly so the spacing/quantifier is explicit.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@skills/lark-base/references/lark-base-workflow-guide.md`:
- Around line 683-709: The JSON examples in the lark-base-workflow-guide contain
non-JSON comments and placeholders (e.g., the blocks showing "condition_list",
"filter_info"/"ref_info", and "value") which will break parsers; update those
fenced code blocks from ```json to ```jsonc or remove the inline
comments/placeholders so the blocks are valid JSON (for example change the three
```json fences around the examples for condition_list, filter_info/ref_info, and
value to ```jsonc or replace // comments and {...} with valid illustrative
values), ensuring the examples remain accurate: condition_list should show null
or omitted, the filter_info/ref_info examples should present one as null and the
other as a real object, and the value example should use a fieldId style string
like "$.step_1.fldXXXXXXXX".
---
Duplicate comments:
In `@skills/lark-base/references/lark-base-workflow-guide.md`:
- Around line 58-62: The table links use anchor slugs like "#示例1-新增记录触发--发送消息"
that don't match the actual heading slugs (which include spacing/punctuation),
causing broken TOC links; update each link to the exact heading slug used in the
document so they match the headings referenced (fix the five entries referencing
"示例1-新增记录触发--发送消息", "示例2-定时触发--查找记录--循环遍历--发送消息", "示例3-条件分支-ifelsebranch",
"示例4-多路分支-switchbranch", and "示例5-组合场景-定时查找循环分支消息") — ensure spacing, hyphens
and casing exactly match the generated slug format (or URL-encode characters) so
the anchors resolve correctly.
---
Nitpick comments:
In `@skills/lark-base/references/lark-base-workflow-guide.md`:
- Line 647: Replace the ambiguous phrase "3路及以上" (exact string) with a clearer
wording such as "3 路及以上" or "3 个分支及以上" in the document text to improve
readability; update the occurrence of "适合多路分类（3路及以上）" accordingly so the
spacing/quantifier is explicit.
🪄 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: defaults
Review profile: CHILL
Plan: Pro
Run ID: 973c7e55-f3e6-4eb6-b8b5-0816c859e949
📒 Files selected for processing (9)
shortcuts/base/workflow_create.goshortcuts/base/workflow_update.goskills/lark-base/SKILL.mdskills/lark-base/references/lark-base-workflow-create.mdskills/lark-base/references/lark-base-workflow-get.mdskills/lark-base/references/lark-base-workflow-guide.mdskills/lark-base/references/lark-base-workflow-list.mdskills/lark-base/references/lark-base-workflow-schema.mdskills/lark-base/references/lark-base-workflow-update.md
✅ Files skipped from review due to trivial changes (4)
- shortcuts/base/workflow_create.go
- skills/lark-base/references/lark-base-workflow-get.md
- shortcuts/base/workflow_update.go
- skills/lark-base/references/lark-base-workflow-schema.md
🚧 Files skipped from review as they are similar to previous changes (4)
- skills/lark-base/references/lark-base-workflow-list.md
- skills/lark-base/references/lark-base-workflow-create.md
- skills/lark-base/references/lark-base-workflow-update.md
- skills/lark-base/SKILL.md
yballul-bytedance
force-pushed
the
feat/workflow_skill_opt
branch
from
2c9ef25 to
970938c
Compare
There was a problem hiding this comment.
Actionable comments posted: 2
♻️ Duplicate comments (3)
skills/lark-base/references/lark-base-workflow-update.md (1)
32-32:⚠️ Potential issue | 🟡 Minor
--json参数说明与本页 Request Body 字段不一致。这里仅写
title/steps，但下方还定义了user_id_type，建议统一说明。🔧 Suggested fix
-| `--json <body>` | 是 | 工作流 body JSON，包含 `title` 和/或 `steps`| +| `--json <body>` | 是 | 工作流 body JSON，支持 `title`、`steps`、`user_id_type` 等字段（PUT 全量覆盖语义） |🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@skills/lark-base/references/lark-base-workflow-update.md` at line 32, 更新 `--json` 参数说明使其与本页的 Request Body 字段一致：在参数描述中列出可包含的字段 `title`, `steps`，并补充 `user_id_type`（以及任何在下方 Request Body 中定义但未在参数说明出现的字段），并在 `--json <body>` 一行中说明这些字段的类型/可选性以保持文档统一（参考 Request Body 中的字段名 title, steps, user_id_type）。skills/lark-base/references/lark-base-workflow-guide.md (2)
683-709:⚠️ Potential issue | 🟡 Minor
json代码块包含注释与占位符，语法并非合法 JSON。当前示例会误导读者直接复制后解析失败；建议改为
jsonc（或移除注释/占位符）。🔧 Suggested fix
-```json +```jsonc // ❌ 错误 { "condition_list": [] } @@ -```json +```jsonc // ❌ 错误 { "filter_info": {...}, "ref_info": {...} } @@ -```json +```jsonc // ❌ 错误 { "value": "$.step_1.客户名称" }🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@skills/lark-base/references/lark-base-workflow-guide.md` around lines 683 - 709, The JSON examples in the lark-base-workflow-guide use comments and placeholders that make them invalid JSON (e.g., examples for condition_list, filter_info/ref_info, and value using human-readable placeholders or comments); update those fenced code blocks to use jsonc or remove comments/placeholders so they become valid/parsable examples: change the three offending ```json blocks to ```jsonc (or replace comments and "..."/"客户名称" placeholders with valid JSON/null values) and ensure fields shown are condition_list, filter_info, ref_info, and value (and not fieldId) use concrete valid JSON values (e.g., null or actual keys) so readers can copy/parse them without errors.
58-62:⚠️ Potential issue | 🟡 Minor目录锚点片段与标题 slug 不一致，链接会失效。
这些 fragment 与实际标题 ID 不匹配（MD051），建议改成与标题一致的 slug 形式。
🔧 Suggested fix
-| 新增触发+通知 | AddRecordTrigger → LarkMessageAction | [下方](`#示例1-新增记录触发--发送消息`) | -| 定时+循环 | TimerTrigger → FindRecordAction → Loop → LarkMessageAction | [下方](`#示例2-定时触发--查找记录--循环遍历--发送消息`) | -| 条件判断 | ... → IfElseBranch → 分支处理 | [下方](`#示例3-条件分支-ifelsebranch`) | -| 多路分类 | ... → SwitchBranch → 多分支处理 | [下方](`#示例4-多路分支-switchbranch`) | -| 复杂组合 | 定时+查找+循环+分支+消息 | [下方](`#示例5-组合场景-定时查找循环分支消息`) | +| 新增触发+通知 | AddRecordTrigger → LarkMessageAction | [下方](`#示例-1-新增记录触发--发送消息`) | +| 定时+循环 | TimerTrigger → FindRecordAction → Loop → LarkMessageAction | [下方](`#示例-2-定时触发--查找记录--循环遍历--发送消息`) | +| 条件判断 | ... → IfElseBranch → 分支处理 | [下方](`#示例-3-条件分支ifelsebranch`) | +| 多路分类 | ... → SwitchBranch → 多分支处理 | [下方](`#示例-4-多路分支switchbranch`) | +| 复杂组合 | 定时+查找+循环+分支+消息 | [下方](`#示例-5-组合场景定时查找循环分支消息`) |🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@skills/lark-base/references/lark-base-workflow-guide.md` around lines 58 - 62, The table's anchor links use fragment text that doesn't match the actual heading slugs (causing MD051 failures); update each link target to match the generated heading ID (slug) for the corresponding section titles (e.g., ensure the link for "示例1-新增记录触发--发送消息" matches the heading slug for that exact title, same for 示例2-定时触发--查找记录--循环遍历--发送消息, 示例3-条件分支-ifelsebranch, 示例4-多路分支-switchbranch, and 示例5-组合场景-定时查找循环分支消息), using the exact lowercase/character normalization used by your markdown renderer so the fragment identifiers match the headings.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@skills/lark-base/references/lark-base-workflow-create.md`:
- Around line 162-167: The fenced code block showing examples contains inline
comments but is labeled as ```json; change the language tag to ```jsonc to match
the commented content so copy/paste and syntax highlighting are correct—edit the
block in lark-base-workflow-create.md replacing the ```json fence with ```jsonc
for the example that includes comment lines (the block containing the two
objects with // ✅ 正确 and // ❌ 错误).
- Line 39: 更新 `--json <body>` 参数说明以与后文 API 字段定义保持一致：说明 JSON body 必须包含
`title`、`steps` 和 必填的 `client_token`，并注明可选字段
`user_id_type`（及其可选值/含义）；确保示例、说明文字和后文 API 字段列表一致，避免仅列出 `title`/`steps` 导致误导。
---
Duplicate comments:
In `@skills/lark-base/references/lark-base-workflow-guide.md`:
- Around line 683-709: The JSON examples in the lark-base-workflow-guide use
comments and placeholders that make them invalid JSON (e.g., examples for
condition_list, filter_info/ref_info, and value using human-readable
placeholders or comments); update those fenced code blocks to use jsonc or
remove comments/placeholders so they become valid/parsable examples: change the
three offending ```json blocks to ```jsonc (or replace comments and "..."/"客户名称"
placeholders with valid JSON/null values) and ensure fields shown are
condition_list, filter_info, ref_info, and value (and not fieldId) use concrete
valid JSON values (e.g., null or actual keys) so readers can copy/parse them
without errors.
- Around line 58-62: The table's anchor links use fragment text that doesn't
match the actual heading slugs (causing MD051 failures); update each link target
to match the generated heading ID (slug) for the corresponding section titles
(e.g., ensure the link for "示例1-新增记录触发--发送消息" matches the heading slug for that
exact title, same for 示例2-定时触发--查找记录--循环遍历--发送消息, 示例3-条件分支-ifelsebranch,
示例4-多路分支-switchbranch, and 示例5-组合场景-定时查找循环分支消息), using the exact
lowercase/character normalization used by your markdown renderer so the fragment
identifiers match the headings.
In `@skills/lark-base/references/lark-base-workflow-update.md`:
- Line 32: 更新 `--json` 参数说明使其与本页的 Request Body 字段一致：在参数描述中列出可包含的字段 `title`,
`steps`，并补充 `user_id_type`（以及任何在下方 Request Body 中定义但未在参数说明出现的字段），并在 `--json
<body>` 一行中说明这些字段的类型/可选性以保持文档统一（参考 Request Body 中的字段名 title, steps,
user_id_type）。
🪄 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: defaults
Review profile: CHILL
Plan: Pro
Run ID: 7c536ce2-43e3-4c8c-9831-c33a0f889c49
📒 Files selected for processing (9)
shortcuts/base/workflow_create.goshortcuts/base/workflow_update.goskills/lark-base/SKILL.mdskills/lark-base/references/lark-base-workflow-create.mdskills/lark-base/references/lark-base-workflow-get.mdskills/lark-base/references/lark-base-workflow-guide.mdskills/lark-base/references/lark-base-workflow-list.mdskills/lark-base/references/lark-base-workflow-schema.mdskills/lark-base/references/lark-base-workflow-update.md
✅ Files skipped from review due to trivial changes (4)
- shortcuts/base/workflow_update.go
- shortcuts/base/workflow_create.go
- skills/lark-base/references/lark-base-workflow-schema.md
- skills/lark-base/references/lark-base-workflow-get.md
🚧 Files skipped from review as they are similar to previous changes (2)
- skills/lark-base/SKILL.md
- skills/lark-base/references/lark-base-workflow-list.md
yballul-bytedance
force-pushed
the
feat/workflow_skill_opt
branch
from
970938c to
e21e01c
Compare
There was a problem hiding this comment.
♻️ Duplicate comments (2)
skills/lark-base/references/lark-base-workflow-update.md (1)
32-32: 🛠️ Refactor suggestion | 🟠 Major
--jsonparameter description is incomplete.The description says "包含
title和/或steps" but omitsuser_id_typewhich is documented as optional in line 68. This creates inconsistency within the same document.📝 Suggested fix
-| `--json <body>` | 是 | 工作流 body JSON，包含 `title` 和/或 `steps`| +| `--json <body>` | 是 | 工作流 body JSON，支持 `title`、`steps`、`user_id_type` 等字段（PUT 全量覆盖，详见下方 API 入参） |🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@skills/lark-base/references/lark-base-workflow-update.md` at line 32, Update the `--json <body>` parameter description to include the optional `user_id_type` field in addition to `title` and `steps` so the docs are consistent with the later mention of `user_id_type`; edit the line showing the parameter (`--json <body>`) and its description to explicitly state it may contain `title`, `steps`, and optionally `user_id_type`.skills/lark-base/references/lark-base-workflow-create.md (1)
39-39: 🛠️ Refactor suggestion | 🟠 Major
--jsonparameter description is incomplete.The description only mentions
titleandsteps, but line 69 showsclient_tokenis required and line 72 showsuser_id_typeis optional. This can mislead users into omittingclient_token, which will cause theclient token is emptyerror mentioned in line 156.📝 Suggested fix
-| `--json <body>` | 是 | 工作流 body JSON，包含 `title` 和 `steps` | +| `--json <body>` | 是 | 工作流 body JSON，必须包含 `client_token`，可包含 `title`、`steps`、`user_id_type` 等字段（详见下方 API 入参） |🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@skills/lark-base/references/lark-base-workflow-create.md` at line 39, Update the `--json` parameter description to list all expected fields and their requirements: include `client_token` as required, `title` and `steps` as required, and `user_id_type` as optional (and note any other optional fields shown elsewhere); reference the `--json` parameter and the JSON body fields (`client_token`, `title`, `steps`, `user_id_type`) in the text so users know they must include `client_token` to avoid the "client token is empty" error.
🧹 Nitpick comments (1)
skills/lark-base/references/lark-base-workflow-guide.md (1)
45-45: Add language specifiers to fenced code blocks.The table markers at lines 45 and 55 are fenced code blocks without language tags, which prevents proper syntax highlighting.
✏️ Suggested fix
-``` +```markdown # Files for review: 5and
-``` +```markdown | 场景 | 步骤组合 | 示例 |Also applies to: 55-55
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@skills/lark-base/references/lark-base-workflow-guide.md` at line 45, Two fenced code blocks lack language specifiers (the one containing "# Files for review: 5" and the table header "| 场景 | 步骤组合 | 示例 |"); update those fenced code blocks in lark-base-workflow-guide.md by adding a language tag (e.g., ```markdown) after the opening backticks so syntax highlighting works correctly for those blocks.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Duplicate comments:
In `@skills/lark-base/references/lark-base-workflow-create.md`:
- Line 39: Update the `--json` parameter description to list all expected fields
and their requirements: include `client_token` as required, `title` and `steps`
as required, and `user_id_type` as optional (and note any other optional fields
shown elsewhere); reference the `--json` parameter and the JSON body fields
(`client_token`, `title`, `steps`, `user_id_type`) in the text so users know
they must include `client_token` to avoid the "client token is empty" error.
In `@skills/lark-base/references/lark-base-workflow-update.md`:
- Line 32: Update the `--json <body>` parameter description to include the
optional `user_id_type` field in addition to `title` and `steps` so the docs are
consistent with the later mention of `user_id_type`; edit the line showing the
parameter (`--json <body>`) and its description to explicitly state it may
contain `title`, `steps`, and optionally `user_id_type`.
---
Nitpick comments:
In `@skills/lark-base/references/lark-base-workflow-guide.md`:
- Line 45: Two fenced code blocks lack language specifiers (the one containing
"# Files for review: 5" and the table header "| 场景 | 步骤组合 | 示例 |"); update those
fenced code blocks in lark-base-workflow-guide.md by adding a language tag
(e.g., ```markdown) after the opening backticks so syntax highlighting works
correctly for those blocks.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: e705574e-0d2f-47c4-9a6c-4f31b2e09130
📒 Files selected for processing (9)
shortcuts/base/workflow_create.goshortcuts/base/workflow_update.goskills/lark-base/SKILL.mdskills/lark-base/references/lark-base-workflow-create.mdskills/lark-base/references/lark-base-workflow-get.mdskills/lark-base/references/lark-base-workflow-guide.mdskills/lark-base/references/lark-base-workflow-list.mdskills/lark-base/references/lark-base-workflow-schema.mdskills/lark-base/references/lark-base-workflow-update.md
✅ Files skipped from review due to trivial changes (4)
- shortcuts/base/workflow_create.go
- shortcuts/base/workflow_update.go
- skills/lark-base/references/lark-base-workflow-list.md
- skills/lark-base/references/lark-base-workflow-get.md
🚧 Files skipped from review as they are similar to previous changes (1)
- skills/lark-base/SKILL.md
yballul-bytedance
force-pushed
the
feat/workflow_skill_opt
branch
2 times, most recently
from
bd11b91 to
a511c53
Compare
Change-Id: I70bce656feea6af54b3366db3e71eea8f1d5b47b
yballul-bytedance
force-pushed
the
feat/workflow_skill_opt
branch
from
a511c53 to
90a20fa
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Change-Id: I70bce656feea6af54b3366db3e71eea8f1d5b47b
Summary
Changes
Test Plan
Related Issues
Summary by CodeRabbit