Skip to content

Docs/lark task shortcut doc refresh - #1057

Merged
liangshuo-1 merged 2 commits into
larksuite:mainfrom
zero-my:docs/lark-task-shortcut-doc-refresh
May 23, 2026
Merged

Docs/lark task shortcut doc refresh#1057
liangshuo-1 merged 2 commits into
larksuite:mainfrom
zero-my:docs/lark-task-shortcut-doc-refresh

Conversation

@zero-my

@zero-my zero-my commented May 23, 2026

Copy link
Copy Markdown
Collaborator

Summary

Align the task attachment wording across the CLI shortcut help text and the lark-task skill documentation. This keeps the user-facing description focused on uploading attachments to tasks and cleans up the skill reference layout.

Changes

  • Simplify task +upload-attachment shortcut help text to describe the core task attachment flow
  • Refresh skills/lark-task/SKILL.md shortcut documentation into a table-based format
  • Remove outdated attachment mentions from the top-level skill description and API resource list since it has a shortcut,it don't need to be mentioned in meta API

Test Plan

  • Unit tests pass
  • Manual local verification confirms the lark task +upload-attachment --help text matches the intended description
  • Manual review confirms the lark-task skill doc reflects the current shortcut list and wording

Related Issues

  • None

Summary by CodeRabbit

  • Documentation
    • Updated shortcut help text for improved clarity
    • Reorganized shortcuts reference documentation into table format with minor description refinements

Review Change Stack

@coderabbitai

coderabbitai Bot commented May 23, 2026

Copy link
Copy Markdown
📝 Walkthrough

Walkthrough

This PR updates the UploadAttachmentTask shortcut's user-facing description text and reformats the task shortcuts documentation from a bullet list to a Markdown table, while removing the permissions mapping for the +upload-attachment shortcut.

Changes

Task Shortcut Updates

Layer / File(s) Summary
Shortcut description update
shortcuts/task/task_upload_attachment.go
UploadAttachmentTask.Description is updated to shorter help text.
Documentation and permissions update
skills/lark-task/SKILL.md
Shortcuts section reformatted from bullet list to Markdown table; permissions table row for +upload-attachment shortcut is removed.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

  • larksuite/cli#736: Introduced the UploadAttachmentTask shortcut and related documentation that this PR now updates.

Suggested labels

domain/task, size/M

Suggested reviewers

  • bytedance-zxy
  • tengchengwei

Poem

🐰 A shortcut's words were far too long,
So we trimmed the help text strong!
Then reshaped the docs so neat,
With a table, clean and sweet. 📋✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title 'Docs/lark task shortcut doc refresh' accurately captures the main change: documentation updates to the lark-task skill and shortcut help text.
Description check ✅ Passed The PR description includes all required template sections: Summary, Changes, Test Plan, and Related Issues, with substantive content and completed verification steps.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

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

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

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.

@github-actions github-actions Bot added domain/task PR touches the task domain size/M Single-domain feat or fix with limited business impact labels May 23, 2026

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
skills/lark-task/SKILL.md (1)

127-165: ⚠️ Potential issue | 🟠 Major | ⚡ Quick win

Restore attachment scope mapping in the permissions section.

+upload-attachment is documented above, but this permissions table no longer exposes its required scope (task:attachment:write). That can lead to under-scoped app configs and avoidable auth failures. Please add an explicit attachment API/scope row (or a shortcut-scope row) for this capability.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@skills/lark-task/SKILL.md` around lines 127 - 165, Add a permissions table
row for the attachment API so the required scope is explicit: include an entry
mapping `upload-attachment` (or the canonical API name used in docs) to
`task:attachment:write` in the same table (or add a shortcut row like
`attachments.*` → `task:attachment:write`) so `upload-attachment` is no longer
undocumented and apps won't be under-scoped.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Outside diff comments:
In `@skills/lark-task/SKILL.md`:
- Around line 127-165: Add a permissions table row for the attachment API so the
required scope is explicit: include an entry mapping `upload-attachment` (or the
canonical API name used in docs) to `task:attachment:write` in the same table
(or add a shortcut row like `attachments.*` → `task:attachment:write`) so
`upload-attachment` is no longer undocumented and apps won't be under-scoped.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: fa238a45-f9db-4488-9378-6dfaec15062c

📥 Commits

Reviewing files that changed from the base of the PR and between ce5b4f2 and 819971b.

📒 Files selected for processing (2)
  • shortcuts/task/task_upload_attachment.go
  • skills/lark-task/SKILL.md

@codecov

codecov Bot commented May 23, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 67.76%. Comparing base (ce5b4f2) to head (819971b).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1057   +/-   ##
=======================================
  Coverage   67.76%   67.76%           
=======================================
  Files         590      590           
  Lines       55194    55194           
=======================================
  Hits        37400    37400           
  Misses      14682    14682           
  Partials     3112     3112           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@github-actions

Copy link
Copy Markdown

🚀 PR Preview Install Guide

🧰 CLI update

npm i -g https://pkg.pr.new/larksuite/cli/@larksuite/cli@819971b54089561f9729c7773d0df773a81023aa

🧩 Skill update

npx skills add zero-my/cli#docs/lark-task-shortcut-doc-refresh -y -g

@liangshuo-1
liangshuo-1 merged commit 6e3e120 into larksuite:main May 23, 2026
19 checks passed
@liangshuo-1 liangshuo-1 mentioned this pull request May 25, 2026
2 tasks
tuxedomm pushed a commit to zhumiaoxin/cli that referenced this pull request Jun 6, 2026
* docs: align lark-task attachment descriptions

* docs: restore lark-task attachment capability summary
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

domain/task PR touches the task domain size/M Single-domain feat or fix with limited business impact

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants