Skip to content

docs(base): enforce complete field update #1937

Open
huarenmin13 wants to merge 1 commit into
larksuite:mainfrom
huarenmin13:agent/base-field-update-workflow
Open

docs(base): enforce complete field update #1937
huarenmin13 wants to merge 1 commit into
larksuite:mainfrom
huarenmin13:agent/base-field-update-workflow

Conversation

@huarenmin13

@huarenmin13 huarenmin13 commented Jul 17, 2026

Copy link
Copy Markdown

Summary

Make Base field updates safe and deterministic by documenting the mandatory read-modify-write flow for the PUT-based +field-update shortcut.

Changes

  • Require a fresh +field-get before every +field-update, including fields created earlier in the same flow.
  • Build the full update payload from the latest field response, remove read-only properties, preserve other writable configuration, and change only the user-requested properties.
  • Bind an existing user confirmation to the first exact update and use --yes for that call; request confirmation again if the readback reveals broader effects.

Test Plan

  • git diff --check
  • Verified skills/lark-base/references/lark-base-field-json.md exists
  • Verified the final diff is limited to skills/lark-base/SKILL.md

Related Issues

  • None

Summary by CodeRabbit

  • Documentation
    • Added a fixed procedure for updating Base fields.
    • Clarified that updates require reading the complete writable configuration before submitting changes.
    • Added guidance to confirm and explain any changes that exceed the requested intent.

@github-actions github-actions Bot added domain/base PR touches the base domain size/M Single-domain feat or fix with limited business impact labels Jul 17, 2026
@coderabbitai

coderabbitai Bot commented Jul 17, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

Adds documentation for a fixed Base field update workflow using read-back configuration, full PUT payloads, confirmation, and re-fetching before subsequent updates.

Changes

Base field update procedure

Layer / File(s) Summary
Field update SOP
skills/lark-base/SKILL.md
Defines the +field-get and +field-update --yes sequence, writable-payload handling, full PUT semantics, and reconfirmation for unintended changes.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Possibly related PRs

  • larksuite/cli#936: Aligns Base +field-update documentation and confirmation requirements with high-risk write behavior.
  • larksuite/cli#1879: Adds overlapping guidance for reading current field configuration before full updates.

Suggested reviewers: liangshuo-1

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
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.
Title check ✅ Passed The title is concise and accurately summarizes the main change to enforce complete Base field updates.
Description check ✅ Passed The description follows the template with Summary, Changes, Test Plan, and Related Issues filled in.
✨ 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.

@huarenmin13 huarenmin13 changed the title docs(base): enforce complete field update workflow docs(base): enforce complete field update Jul 17, 2026
@github-actions

Copy link
Copy Markdown

🚀 PR Preview Install Guide

🧰 CLI update

npm i -g https://pkg.pr.new/larksuite/cli/@larksuite/cli@970d37a85bfcbc24377ad4dad85ac729d92b80dc

🧩 Skill update

npx skills add huarenmin13/cli#agent/base-field-update-workflow -y -g

Comment thread skills/lark-base/SKILL.md
- 文档嵌入 Base 标签:直接读取 `<bitable>` / `<base_refer>` 的 `token` 作为 `--base-token`,`table-id` 作为 `--table-id`,`view-id` 作为 `--view-id`;孤立 raw token 不走 `+url-resolve`。
- 仍无法定位且用户不是要新建 Base 时,先反问用户要操作哪一个 Base;用户要新建时才用 `+base-create`。

## 字段更新固定流程

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

  1. 仅“字段更新”这个小点的话,没必要在顶层skill.md新建一个一级章节。
  2. 不止字段更新是PUT全量更新,图表配置,工作流配置也都是,最好统一描述
  3. 这段文字,感觉表达方面写的不好。重点不够突出,你觉得呢

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

是的,这是完全loop跑出来的,只能说解决了问题,但是合理性和通用性不足。

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

strategy中补充一下,改动位置应全局找合适位置,只有现有结构无法承载时再新增章节。

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

domain/base PR touches the base 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