voxpupuli/vox-pupuli-tasks

Vox Pupuli Tasks - 社区管理Web应用

镜像概述和主要用途

Vox Pupuli Tasks是一个专为Vox Pupuli社区设计的Web应用，旨在帮助协作者更高效地管理社区任务。主要用途包括审查开放的Pull Request（PR）和维护Puppet模块（即"Yak shaving"），通过自动化工具和直观界面减少协作者的重复工作，聚焦需要关注的任务。

核心功能和特性

PR审查优化

• 智能过滤无需关注的PR（如存在合并冲突的PR），仅展示需要审查的内容
• 集成GitHub OAuth认证，确保仅社区成员访问
• 展示PR详细信息，支持多维度筛选和分类

Puppet模块维护自动化

• 合并冲突处理：自动检测PR合并冲突状态变化，添加/移除merge-conflicts标签并评论通知作者
• GitHub标签同步：维护权威标签列表（名称、颜色、描述），确保所有仓库标签配置一致
• 操作系统支持检查：验证Puppet模块元数据中支持的操作系统版本是否符合社区标准

使用场景和适用范围

• Vox Pupuli协作者：日常PR审查、模块维护工作流程优化
• Puppet模块开发者：获取模块改进建议、自动化处理常见维护任务
• 社区管理者：监控社区活动，确保模块质量和维护一致性

使用方法和配置说明

访问在线版本

目前可通过beta版本[***] OAuth登录，无需授予仓库访问权限，仅用于身份验证。

本地部署

前提条件

• Ruby、Bundler、Yarn环境
• Redis服务

部署步骤

sh
git clone git@github.com:voxpupuli/vox-pupuli-tasks.git
cd vox-pupuli-tasks
bundle install --jobs $(nproc) --with development test --path vendor/bundle
bundle exec yarn install --frozen-lockfile --non-interactive
export SECRET_KEY_BASE=$(bundle exec rails secret)
bundle exec rails assets:precompile
# 需开发者提供config/master.key文件
RAILS_ENV=development bundle exec rails db:migrate
bundle exec foreman start

密钥管理

编辑加密配置文件：

sh
bundle exec rails credentials:edit

生产环境部署

生产环境采用Docker微服务架构，通过docker-compose.yaml部署，包含以下服务：

• watchtower：自动更新容器
• cerebro：Elasticsearch管理界面（端口9001）
• Elasticsearch：日志存储
• Redis：缓存和Sidekiq后端
• Sidekiq：后台任务处理
• Kibana：Elasticsearch可视化（端口5601）
• Sentry：错误跟踪
• 应用本身

Docker Compose示例

yaml
version: '3'
services:
  elasticsearch:
    image: docker.elastic.co/elasticsearch/elasticsearch:7.14.0
    environment:
      - discovery.type=single-node
    ports:
      - "9200:9200"
  kibana:
    image: docker.elastic.co/kibana/kibana:7.14.0
    ports:
      - "5601:5601"
    depends_on:
      - elasticsearch
  redis:
    image: redis:6-alpine
  web:
    build: .
    depends_on:
      - redis
      - elasticsearch
    environment:
      - RAILS_ENV=production
      - SECRET_KEY_BASE=your_secret_key
  sidekiq:
    build: .
    command: bundle exec sidekiq
    depends_on:
      - redis
      - web

GitHub App配置

必要设置

• 用户授权回调URL：https://<your-domain>/auth/github/callback
• Webhook URL：https://<your-domain>/incoming/github
• 权限配置：
  • 管理（Administration）：读写权限（用于标签管理）
  • 问题（Issues）：读写权限（PR属于特殊Issue）
  • Pull Request：读写权限
• 事件订阅：
  • Issue评论（Issue comment）
  • 标签（Label）
  • 仓库（Repository）
  • Pull Request
  • 问题（Issues）

贡献与开发

代码检查

提交PR前运行代码风格检查：

sh
bundle exec rake rubocop

自动修复部分问题：

sh
bundle exec rake rubocop::auto_correct

添加新操作系统检查

1. 更新版本数组（config/initializers/voxpupuli.rb）
2. 更新提示信息（config/locales/en.yml）

许可证

本项目采用GNU Affero General Public License v3许可。

赞助

本项目由Hetzner Cloud赞助，提供免费云服务器支持。