Forgejo Sync

Forgejo Sync Skill

版本: 1.0.0 | 层级: Layer 2 (Business Skill) | 分类: Requirements Skills

快速开始

我应该使用这个 Skill 吗？

使用场景:

• 将 Story 创建为 Forgejo Issue
• 从 Issue 同步状态回 Story
• 发布 PRD 到 Forgejo Wiki
• 检查 Story/Issue 状态差异

不使用场景:

• 验证文档格式 → 使用 requirements-validator
• 同步到 UPM → 使用 requirements-sync

前置条件:

• 配置 Forgejo API 访问 (见 CONFIG.md)

核心功能

Forgejo 配置引导 (v1.14.0 新增)

forgejo-sync 在 PRE_CHECK 步骤中自动检测 Forgejo 配置是否就位。

触发条件

• git remote URL 包含已知 Forgejo 实例 (forgejo.10cg.pub)
• CLAUDE.local.md 不存在，或文件存在但缺少 forgejo: 配置块

行为

文件不存在时:

1. 从 git remote URL 推断 owner/repo (支持 SSH git@host:owner/repo.git 和 HTTPS 格式)
2. 对已知实例默认 cloudflare_access.enabled: true
3. 展示将要生成的完整配置内容
4. 提示用户确认 [y/N]
5. 确认 → 创建 CLAUDE.local.md，继续后续步骤
6. 拒绝 → 输出 "跳过配置创建，forgejo-sync 可能因 Cloudflare 拦截而失败"，继续执行

文件存在但缺少 forgejo 块时:

1. 展示将要追加的 forgejo 配置块
2. 提示用户确认 [y/N]
3. 确认 → 在文件末尾追加 forgejo 配置块
4. 拒绝 → 同上，继续执行

已有 forgejo 配置时: 不提示，直接进入原有 PRE_CHECK 流程。

生成模板

与现有配置 schema 字段一致:

## Forgejo Integration
forgejo:
  url: "https://forgejo.10cg.pub"
  repo: "{owner}/{repo}"
  cloudflare_access:
    enabled: true
    client_id_env: "CF_ACCESS_CLIENT_ID"
    client_secret_env: "CF_ACCESS_CLIENT_SECRET"

设计约束

• 用户拒绝后不记忆状态，下次调用仍提示 (无状态设计)
• 仅对已知实例 (forgejo.10cg.pub) 生效，硬编码白名单
• 不修改已有 forgejo 配置块内容

配置

必需配置

在 .claude/skills/forgejo-sync/CONFIG.md 或 CLAUDE.local.md 中配置:

forgejo:
  url: "https://forgejo.example.com"
  api_token: "${FORGEJO_TOKEN}"   # 环境变量
  repo: "owner/repo"

可选配置

forgejo:
  default_labels: ["user-story"]
  auto_create_milestone: true
  wiki:
    enabled: true
    page_prefix: "PRD-"
    generate_index: true

状态映射

Story → Issue

Issue → Story

Priority 映射

执行流程

🔒 AI 执行前检查 (不可协商规则)

CRITICAL: 在执行任何 Forgejo API 调用前，AI 必须遵循以下检查流程。 统一规范: 引用 PRE_CHECK.md (同目录)

检查流程

# 统一的前置检查规范
引用: PRE_CHECK.md

API_Call_Pre_Check:
  1. 读取配置:
     - 读取 CLAUDE.local.md 或 CONFIG.md
     - 查找 forgejo.cloudflare_access.enabled 值

  2. 根据 enabled 状态决定调用模式:
     enabled = true:
       → 使用 Cloudflare Access 模式
       → 必须添加两个头部:
         - CF-Access-Client-Id: ${CF_ACCESS_CLIENT_ID}
         - CF-Access-Client-Secret: ${CF_ACCESS_CLIENT_SECRET}

     enabled = false 或未设置:
       → 使用标准模式
       → 仅添加标准 Authorization 头部

  3. 执行后检测:
     - 检查 HTTP 状态码
     - 检查响应内容
     - 如果 403 或包含 "cloudflare"/"challenge":
       → 自动提示用户配置 Cloudflare Access

API 调用模板 (引用统一规范)

标准模式 (cloudflare_access 未启用):

curl -H "Authorization: token ${FORGEJO_TOKEN}" \
  -H "Content-Type: application/json" \
  "${FORGEJO_API_URL}/repos/{owner}/{repo}/issues"

Cloudflare Access 模式 (cloudflare_access.enabled = true):

curl \
  -H "Authorization: token ${FORGEJO_TOKEN}" \
  -H "CF-Access-Client-Id: ${CF_ACCESS_CLIENT_ID}" \
  -H "CF-Access-Client-Secret: ${CF_ACCESS_CLIENT_SECRET}" \
  -H "Content-Type: application/json" \
  "${FORGEJO_API_URL}/repos/{owner}/{repo}/issues"

错误检测与自动提示

检测条件:

• HTTP 状态码: 403
• 响应包含关键词: "cloudflare" OR "challenge" OR "access denied"

自动提示模板:

⚠️ 检测到 Cloudflare Access 保护

Forgejo API 调用被拒绝 (403)，响应中包含 Cloudflare challenge。
请在 CLAUDE.local.md 中添加以下配置：

forgejo:
  url: "你的 Forgejo URL"
  api_token: "${FORGEJO_TOKEN}"
  repo: "owner/repo"
  cloudflare_access:
    enabled: true
    client_id_env: "CF_ACCESS_CLIENT_ID"
    client_secret_env: "CF_ACCESS_CLIENT_SECRET"

并设置环境变量：
export CF_ACCESS_CLIENT_ID="your-client-id"
export CF_ACCESS_CLIENT_SECRET="your-service-token"

Story → Issue

步骤:
  1. 读取 Story 文件
  2. 检查是否已有 Forgejo Issue 字段
  3. 如无，调用 API 创建 Issue
     - Title: "[US-XXX] {标题}"
     - Body: Story 内容 + 验收标准
     - Labels: ["user-story", "{status}", "{priority}"]
     - Milestone: 从 Story 读取
  4. 更新 Story 文件的 Forgejo Issue 字段

输出:
  issue_created: true
  issue_number: 123
  issue_url: "https://forgejo.example.com/owner/repo/issues/123"

Issue → Story

步骤:
  1. 读取 Story 文件的 Forgejo Issue 字段
  2. 调用 API 获取 Issue 状态
  3. 根据状态映射更新 Story Status
  4. 保存 Story 文件

输出:
  story_updated: true
  old_status: "ready"
  new_status: "in_progress"

PRD → Wiki

步骤:
  1. 读取 PRD 文件
  2. 检查 PRD 状态是否为 approved
  3. 调用 Wiki API 创建/更新页面
     - Page Name: "PRD-{version}-{feature}"
     - Content: PRD 内容 + 自动页脚
  4. 更新 UPM 的 wiki_page 字段

输出:
  wiki_published: true
  page_name: "PRD-v2.1.0-notification"
  page_url: "https://forgejo.example.com/owner/repo/wiki/PRD-v2.1.0-notification"

输出格式

forgejo_sync_result:
  action: "story-to-issue|issue-to-story|bulk-sync|prd-to-wiki"
  timestamp: "2026-01-01T10:00:00+08:00"

  stories:
    processed: N
    created: N
    updated: N
    skipped: N

  issues:
    created: N
    updated: N

  wiki:
    published: N
    skipped: N

  drift:
    detected: true/false
    items: [...]

  errors: [...]

API 调用

创建 Issue

method: POST
url: /api/v1/repos/{owner}/{repo}/issues
headers:
  Authorization: "token ${FORGEJO_TOKEN}"
body:
  title: "[US-001] Feature Title"
  body: |
    ## User Story
    As a {role}...

    ## Acceptance Criteria
    - [ ] Criteria 1
    - [ ] Criteria 2

    ---
    Story File: `docs/requirements/user-stories/US-001-xxx.md`
  labels: ["user-story", "ready", "priority:high"]
  milestone: 1

更新 Issue

method: PATCH
url: /api/v1/repos/{owner}/{repo}/issues/{id}
body:
  state: "open|closed"
  labels: [...]

创建 Wiki 页面

method: PUT
url: /api/v1/repos/{owner}/{repo}/wiki/page/{pageName}
body:
  title: "PRD: Feature Title"
  content: |
    {prd_content}

    ---
    > **Source**: `docs/requirements/prd-v2.1.0-xxx.md`
    > **Last Synced**: 2026-01-01T10:00:00
    > **Note**: Auto-synced from Git. Do not edit directly.

使用示例

创建单个 Issue

用户: 为 US-001 创建 Forgejo Issue

助手执行:
1. 读取 US-001-xxx.md
2. 调用 Forgejo API 创建 Issue
3. 更新 Story 文件

输出:
forgejo_sync_result:
  action: "story-to-issue"
  issues:
    created: 1
  story_updated: "US-001-xxx.md"
  issue_url: "https://..."

批量同步

用户: 同步所有 Story 到 Forgejo

助手执行:
1. 扫描所有 Story 文件
2. 为无 Issue 的 Story 创建 Issue
3. 同步有 Issue 的 Story 状态

输出:
forgejo_sync_result:
  action: "bulk-sync"
  stories:
    processed: 8
    created: 3
    updated: 5

发布 PRD

用户: 发布 PRD 到 Wiki

助手执行:
1. 读取 PRD 文件
2. 检查状态为 approved
3. 调用 Wiki API 发布

输出:
forgejo_sync_result:
  action: "prd-to-wiki"
  wiki:
    published: 1
  page_url: "https://..."

与其他 Skills 的关系

┌─────────────────────────────────────────────────────────────┐
│  requirements-validator (Layer 2)                           │
│      │ 验证后                                                │
│      ▼                                                      │
│  requirements-sync (Layer 2)                                │
│      │ 同步 UPM 后                                           │
│      ▼                                                      │
│  forgejo-sync (Layer 2) ◄── 本 Skill                        │
│      │                                                      │
│      ▼                                                      │
│  Forgejo API (外部)                                         │
└─────────────────────────────────────────────────────────────┘

相关文档

• 规范: openspec/specs/forgejo-sync/spec.md
• 配置模板: CONFIG.md (同目录)
• Story 模板: standards/templates/user-story-template.md
• PRD 模板: standards/templates/prd-template.md