Skip to content

chore(repo): update workwork metadata#74

Open
pengx17 wants to merge 2 commits into
mainfrom
codex/update-workwork-metadata
Open

chore(repo): update workwork metadata#74
pengx17 wants to merge 2 commits into
mainfrom
codex/update-workwork-metadata

Conversation

@pengx17
Copy link
Copy Markdown
Collaborator

@pengx17 pengx17 commented May 31, 2026

Context

workwork 仓库已经从 Slack-only broker 演进为 Slack + China Feishu 双平台 broker,但 README、package metadata、默认服务名和部分 GitHub-facing client metadata 仍然停留在 slack-codex-broker

这次把公开入口收敛到 workwork,同时把 README 从长篇 runbook 清理成项目主页:先说明 Workwork 是什么、核心流程、怎么启动和验证;平台差异只留在 setup / compatibility 的渐进式细节里。

协作过程

sequenceDiagram
    participant User as Peng
    participant Codex
    participant Repo as workwork repo
    participant GH as GitHub

    User->>Codex: 更新 README 和仓库基本信息
    Codex->>Repo: 扫描 README/package/config/admin metadata
    Codex->>Repo: 统一 workwork 命名与 GitHub URL
    Codex->>GH: 创建 PR #74 并更新 topics
    User->>Codex: README 太长,缺乏重点
    Codex->>Repo: 精简 README,保留 RFC/audit 必要承诺
    User->>Codex: 不需要着重讲平台差异
    Codex->>Repo: 移除首屏平台对照,改成统一 core flow
    Codex->>Repo: 跑 format/RFC/full test 验证
Loading

方案讨论

  • README 不再把 Slack/Feishu 差异放在首屏主结构里,改成 What It Does + Core Flow
  • Feishu 权限、证据、API compatibility 这类细节保留在 setup 和 <details> 中,避免首页过载,同时不破坏 RFC/audit 对用户可见承诺的检查。
  • 没有重命名现有 real ops container 默认名 slack-codex-broker-real,因为它属于现有部署兼容项;README 中明确标成 legacy default。
  • npm 发布包名仍保留 @agent-session-broker/admin / @agent-session-broker/worker,避免发布通道改名。

最终方案

  • README 标题和开头定位改为 workwork,压缩为项目主页式结构,并用 details 渐进披露长尾 contract。
  • root/admin/worker package metadata 指向 https://github.com/HOOLC/workwork
  • 默认 SERVICE_NAME、docker compose service、admin UI title/config、MCP OAuth client metadata、GitHub user-agent 改为 workwork
  • npm package deployment contract 测试同步锁住新 metadata。
  • GitHub topics 已更新为 automation, broker, codex, feishu, slack

验证情况

  • pnpm format:check
  • pnpm lint
  • pnpm build
  • pnpm test
  • pnpm test test/rfc-0001-docs.test.ts test/rfc-0001-local-audit.test.ts test/rfc-0001-test-plan.test.ts
  • pnpm test test/e2e-broker-part2.test.ts
  • pnpm rfc:feishu-test-plan -- --json
  • git diff --check

已知局限 / 后续工作

  • GitHub repo description 仍是旧文案,建议改为:Slack + China Feishu broker that routes chat sessions into Codex app-server sessions with isolated workspaces.
  • GitHub repo homepage 建议改为:https://github.com/HOOLC/workwork#readme
  • 我当前 token 更新 GitHub About description/homepage 时 GitHub API 返回 404;topics 已更新成功,但 description/homepage 需要有 repo admin 权限的人补。

@pengx17 pengx17 force-pushed the codex/update-workwork-metadata branch from 9e9417c to b21721a Compare May 31, 2026 08:29
@pengx17 pengx17 force-pushed the codex/update-workwork-metadata branch from b21721a to 63b92c1 Compare May 31, 2026 08:42
@pengx17
Copy link
Copy Markdown
Collaborator Author

pengx17 commented May 31, 2026

Review notes:

  • README Admin/API contract drift (blocking-ish docs issue): the new README still documents GET /admin/api/status?platform=slack|feishu, POST /admin/api/github-authors, and DELETE /admin/api/github-authors/:userId?platform=slack|feishu as platform-aware. The current routes ignore platform for /admin/api/status, and the GitHub author admin routes still accept only slack_user_id / call Slack-only admin service methods. Since this PR turns README into the public project homepage, I’d either remove those platform-aware claims or update the routes/tests to match. Related: test/rfc-0001-docs.test.ts currently locks some of these stale README strings, so the test should move with the doc correction.

Everything else I checked looks consistent with the rename/metadata goal: package metadata, default SERVICE_NAME, docker compose service, admin title/default, MCP client metadata, and GitHub User-Agent all line up with workwork; CI is green.

@pengx17 pengx17 force-pushed the codex/update-workwork-metadata branch from cc3e8d5 to 754878c Compare May 31, 2026 09:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant