4.7 KiB

Raw Blame History

Feishu Integration

gitlink-cli feishu exports local GitLink workflow JSON to Feishu.

The stable command path is intentionally narrow:

workflow JSON -> local preview
workflow JSON -> Feishu custom bot card
workflow JSON -> weekly report
workflow JSON -> Bitable schema / records dry-run

Stable Commands

gitlink-cli feishu +bot-test
gitlink-cli feishu +notify
gitlink-cli feishu +weekly-report
gitlink-cli feishu +bitable-schema
gitlink-cli feishu +bitable-records

feishu +doc-export exists as an experimental command. It uses Feishu self-built app OpenAPI and is not part of the clean first-path workflow.

Safety Model

Default behavior is local preview.
Real Feishu bot delivery requires --send.
--send and --dry-run cannot be used together.
Webhook URLs are redacted in command output.
Secrets and tokens are never intentionally printed.
The stable commands do not write to GitLink resources.
Bitable commands are dry-run only and do not call Bitable OpenAPI.

Custom Bot Setup

Use a Feishu custom group bot for notification cards.

Environment:

$env:FEISHU_WEBHOOK_URL="https://open.feishu.cn/open-apis/bot/v2/hook/..."
$env:FEISHU_WEBHOOK_SECRET="optional signing secret"

Preview a test card:

gitlink-cli feishu +bot-test --format json

Send a test card:

gitlink-cli feishu +bot-test --send --format table

Workflow Report Card

Generate workflow JSON:

gitlink-cli workflow +repo-report --owner Gitlink --repo gitlink-cli --format json > report.json

On Windows PowerShell, redirected files may be written with UTF-16 encoding. feishu workflow JSON readers accept UTF-8 and UTF-16 BOM files so the redirected output above can be consumed directly.

Preview a card:

gitlink-cli feishu +notify --from-workflow-json report.json --format json

Send a card:

gitlink-cli feishu +notify --from-workflow-json report.json --send --format table

Send a card with an existing Feishu document or Wiki link:

gitlink-cli feishu +notify \
  --from-workflow-json report.json \
  --doc-url "https://example.feishu.cn/wiki/..." \
  --send \
  --format table

Weekly Report

Render markdown:

gitlink-cli feishu +weekly-report --from-workflow-json report.json --format markdown

Send a weekly summary card:

gitlink-cli feishu +weekly-report --from-workflow-json report.json --send --format table

Bitable Dry Run

Generate recommended table schemas:

gitlink-cli feishu +bitable-schema --format markdown

Generate Bitable-ready records:

gitlink-cli feishu +bitable-records --from-workflow-json report.json --format json

These records are summary records derived from workflow repo-report JSON. They are not a per-issue or per-PR synchronization.

Role-Aware Collaboration Roadmap

The Feishu integration is designed to support two different notification modes:

Owner / maintainer: summarized digest.
Contributor: immediate personal feedback.

Owner-oriented cards should group PRs by review stage instead of sending one message for every PR event. Recommended stages:

blue: new or unreviewed
grey: active review
green: close to merge or merged
yellow: needs rebase
orange: major changes requested
red: blocked

Contributor notifications are different. A contributor should receive fast feedback when their own PR is reviewed, commented on, blocked by rebase/conflict, approved, merged, or closed.

Long-form project material should be exported to Feishu Docs / Wiki:

README summary
contribution guide
owner digest archive
milestone plan
PR stage table

Milestone and Gantt support should start as Bitable-ready records and document sections. Real Bitable writes and view creation require a separate permissioned OpenAPI design.

Detailed design:

feishu-export-design/ROLE_BASED_COLLABORATION.md

Experimental DocX / Wiki Export

feishu +doc-export is experimental because it uses Feishu self-built app credentials and writes to DocX / Wiki through OpenAPI.