traefik/bibikoffi

Myrmica Bibikoffi - 关闭陈旧议题

https://github.com/traefik/bibikoffi/workflows/Main/badge.svg?branch=master](https://github.com/traefik/bibikoffi/actions)

镜像概述和主要用途

Myrmica Bibikoffi 是一款用于自动关闭 GitHub 仓库中陈旧议题（stale issues）的工具。它通过配置文件定义规则，可识别并处理长时间未活动的议题，帮助团队自动管理仓库中的议题生命周期，减少手动维护成本。

核心功能与特性

• 陈旧议题处理：自动识别并关闭 GitHub 上符合条件的陈旧议题。
• 配置文件支持：使用 TOML 配置文件定义处理规则（参考 https://github.com/traefik/bibikoffi/blob/master/sample.toml%EF%BC%89%E3%80%82
• 调试模式：支持开启调试模式，便于问题排查。
• Dry Run 模式：默认启用模拟运行，仅展示操作结果而不实际执行，确保配置安全。
• 服务器模式：可通过服务器模式运行，提供 HTTP 服务接口（需手动开启）。

使用场景与适用范围

适用于需要自动化管理 GitHub 仓库议题的团队或个人，尤其是：

• 维护多个开源项目，需处理大量长时间未活动的议题。
• 希望减少手动清理陈旧议题的重复工作。
• 需要通过配置文件自定义议题关闭规则（如未活动时长、忽略标签等）。

使用方法与配置说明

配置参数（命令行 Flags）

配置文件（TOML）

需通过 --config-path 指定 TOML 配置文件，用于定义陈旧议题处理规则（如未活动天数、忽略标签、关闭评论等）。具体配置项参考 https://github.com/traefik/bibikoffi/blob/master/sample.toml%E3%80%82

命令示例

基本用法（使用默认配置文件，模拟运行）

bash
bibikoffi -t YOUR_GITHUB_TOKEN

指定配置文件路径并关闭 Dry Run（实际执行）

bash
bibikoffi -t YOUR_GITHUB_TOKEN --config-path /path/to/config.toml --dry-run false

开启调试模式和服务器模式（端口 8080）

bash
bibikoffi -t YOUR_GITHUB_TOKEN --debug true --server true --port 8080

Docker 部署

Docker Run 命令示例

bash
docker run -d \
  --name bibikoffi \
  -v /path/to/your/bibikoffi.toml:/app/bibikoffi.toml \  # 挂载配置文件
  -e GITHUB_TOKEN=YOUR_GITHUB_TOKEN \                  # 设置 GitHub Token
  traefik/bibikoffi \
  --dry-run false --server true --port 8080            # 自定义参数

Docker Compose 配置示例

yaml
version: '3'
services:
  bibikoffi:
    image: traefik/bibikoffi
    volumes:
      - ./bibikoffi.toml:/app/bibikoffi.toml  # 挂载本地配置文件
    environment:
      - GITHUB_TOKEN=YOUR_GITHUB_TOKEN       # GitHub Token
    command: --dry-run false --server true --port 8080  # 运行参数
    ports:
      - "8080:8080"  # 暴露服务器端口

相关工具（Myrmica 系列）

Myrmica 系列工具是 Traefik 团队开发的自动化工具集，用于 GitHub 仓库管理：

• https://github.com/traefik/lobicornis 🐜：更新并合并拉取请求。
• https://github.com/traefik/aloba 🐜：为拉取请求和议题添加标签与里程碑。
• https://github.com/traefik/structor 🐜：使用 Mkdocs 管理多版本文档。
• https://github.com/traefik/mixtus 🐜：从一个仓库发布文档到另一个 GitHub 仓库。
• https://github.com/traefik/kutteri 🐜：跟踪 GitHub 仓库并发布通知到 Slack。
• https://github.com/traefik/gallienii 🐜：保持 Fork 仓库与上游同步。

名称含义

Myrmica Bibikoffi 是一种蚂蚁的学名（中文译名：比氏蚁）。该工具以蚂蚁命名，象征其自动化、高效处理仓库管理任务的特性，如同蚂蚁群体协作般可靠。

!Myrmica Bibikoffi