dalongrong/wekan

wekan-gogs

镜像概述和主要用途

wekan-gogs是一个轻量级NodeJS应用，旨在实现[***]

核心功能和特性

• 双向数据同步：Gogs中创建Issue自动在Wekan生成卡片，反之亦然
• 评论同步：Gogs Issue评论与Wekan卡片评论双向同步
• 状态联动：Wekan卡片列表移动自动更新Gogs Issue对应标签
• 优先级管理：支持优先级模式，标记为"kan:Priority"的Gogs Issue自动同步至Wekan Priority看板
• 自动化标签管理：自动创建与Wekan列表对应的Gogs标签（如"kan:To Do"、"kan:In Progress"等）

使用场景和适用范围

适用于需要将项目管理（Wekan看板）与代码开发（Gogs仓库）流程深度集成的团队，尤其适合敏捷开发场景，可实现任务状态透明化、开发流程自动化，减少手动同步成本。

使用方法和配置说明

Docker部署

docker-compose配置

创建docker-compose.yml文件，根据实际环境修改环境变量：

yaml
version: '2'

services:
  wekan-gogs:
    image: toroid/wekan-gogs
    ports:
      - 7654:7654
    volumes:
      - wekan-gogs-db:/home/node/wekan-gogs/data
    restart: always
    environment:
      - WG_WEKAN_URL=https://my-wekan.io:8081  # Wekan实例URL
      - WG_WEKAN_USERNAME=wuser                # Wekan管理员用户名
      - WG_WEKAN_PASSWORD=wpass                # Wekan管理员密码
      - WG_GOGS_URL=https://my-gogs.io         # Gogs实例URL
      - WG_GOGS_USERNAME=guser                 # Gogs管理员用户名
      - WG_GOGS_PASSWORD=gpass                 # Gogs管理员密码
      - WG_URL=http://172.19.0.1:7654          # wekan-gogs服务自身URL
      - WG_CLI=true                            # 启用CLI模式
    stdin_open: true
    tty: true

volumes:
  wekan-gogs-db:
    driver: local

启动服务

执行以下命令启动服务，数据库将存储在wekan-gogs-db卷中：

bash
docker-compose up -d

访问CLI

目前无图形界面，所有操作需通过CLI执行。使用以下命令连接容器：

bash
docker attach {{容器名称或ID}}

提示：使用^P^Q组合键可安全退出容器，避免终止服务。

用户指南

首次运行

首次启动后，系统将自动在Gogs注册应用，并在Wekan创建"Priority"看板。

添加同步仓库

默认不同步任何仓库，需手动激活同步。

1. 更新仓库列表

bash
wekan-gogs: sync repos

查看仓库列表：

bash
wekan-gogs: list
┌─────────────┬────────┬───────────────────┐
│ Name        │ Active │ Active (Priority) │
├─────────────┼────────┼───────────────────┤
│ andres/test │        │                   │
├─────────────┼────────┼───────────────────┤
│ andres/lala │        │                   │
└─────────────┴────────┴───────────────────┘

2. 激活仓库同步

普通模式激活（创建对应看板及标签）：

bash
wekan-gogs: activate andres test

激活后仓库状态：

bash
wekan-gogs: list
┌─────────────┬────────┬───────────────────┐
│ Name        │ Active │ Active (Priority) │
├─────────────┼────────┼───────────────────┤
│ andres/test │ X      │                   │
├─────────────┼────────┼───────────────────┤
│ andres/lala │        │                   │
└─────────────┴────────┴───────────────────┘

激活后将自动创建以下内容：

• Wekan看板（命名格式：repo_owner/repoName）
• Gogs标签（对应Wekan列表）：kan:To Do、kan:In Progress、kan:Review、kan:Done

优先级模式激活（额外添加"kan:Priority"标签，支持Priority看板同步）：

bash
wekan-gogs: activate --priority andres test

优先级模式状态：

bash
wekan-gogs: list
┌─────────────┬────────┬───────────────────┐
│ Name        │ Active │ Active (Priority) │
├─────────────┼────────┼───────────────────┤
│ andres/test │ X      │ X                 │
├─────────────┼────────┼───────────────────┤
│ andres/lala │        │                   │
└─────────────┴────────┴───────────────────┘

3. 同步历史Issue

仓库激活后，系统自动同步激活后创建的Issue。如需同步历史Issue，需手动执行（Gogs API分页，需指定页码）：

bash
wekan-gogs: sync issues andres test 1  # 同步第1页Issue

同步后，历史Issue将以卡片形式显示在Wekan的"To Do"列表，并自动分配对应标签。

命令帮助

查看所有可用命令：

bash
wekan-gogs: help

  Commands:

    help [command...]                       查看命令帮助
    exit                                    退出应用
    list [options]                          列出仓库
    deactivate [options] <username> <repo>  停用仓库同步
    activate [options] <username> <repo>    激活仓库同步
    sync issues <username> <repo> <page>    同步仓库Issue（需先激活）
    sync repos [username]                   同步仓库列表