shibayu36/notify-issues-to-slack

notify-issues-to-slack

![Build Status]([] ![License: MIT]([]

本项目处于alpha阶段，接口可能会在未来发生变化。

镜像概述

这是一个命令行工具，可将GitHub的issues和pull requests以带颜色标记的方式推送到Slack，帮助团队进行代码审查提醒和定期检查任务。

核心功能

• 支持GitHub issues/PR搜索语法，可精准筛选目标内容
• 支持相对时间查询（如created:<now-1w）
• 可通过danger-filter和warning-filter为内容添加颜色标记
• 支持自定义Slack用户名、图标及推送频道
• 兼容GitHub Enterprise，可指定私有API地址
• 支持模板化自定义消息和issue展示格式

使用场景

• 代码审查提醒：定期推送待审查的PR到团队频道
• 问题跟踪：监控未处理的bug或待分配的任务
• 状态同步：向团队同步特定标签的issues/PR更新

配置说明

必要参数

• -github-token: GitHub访问令牌（需具备repo权限）
• -slack-webhook-url: Slack Webhook地址
• -query: GitHub搜索查询语句（参考https://help.github.com/en/articles/searching-issues-and-pull-requests%EF%BC%89

可选参数

• -channel: Slack推送频道（默认使用Webhook配置的频道）
• -danger-filter: 标记为危险（红色）的筛选条件
• -warning-filter: 标记为警告（黄色）的筛选条件
• -username: Slack推送用户名
• -icon-emoji: Slack推送图标表情
• -github-api-url: GitHub Enterprise API地址（如https://ghe.example.com/api/v3）
• -text: 自定义推送消息（支持Go模板语法）
• -issue-text-format: 自定义issue展示格式（支持Go模板语法）

Docker部署示例

拉取镜像

console
docker pull shibayu36/notify-issues-to-slack

基础使用

console
docker run --rm shibayu36/notify-issues-to-slack \
  -github-token="your-github-token" \
  -slack-webhook-url="your-slack-webhook" \
  -query="repo:your-org/your-repo state:open label:bug" \
  -text="请检查未处理的bug @team"

带颜色标记的使用

console
docker run --rm shibayu36/notify-issues-to-slack \
  -github-token="your-github-token" \
  -slack-webhook-url="your-slack-webhook" \
  -query="repo:your-org/your-repo state:open label:review-required" \
  -danger-filter="updated:<now-2d type:pr review:none" \
  -warning-filter="type:pr review:none" \
  -username="审查提醒机器人" \
  -icon-emoji=":mag:"

常用查询示例

1. 推送无reviewer且超过2天未处理的PR：

console
docker run --rm shibayu36/notify-issues-to-slack \
  -github-token="..." \
  -slack-webhook-url="..." \
  -query="repo:your-org/your-repo label:review-required state:open" \
  -danger-filter="updated:<=now-2d type:pr review:none" \
  -warning-filter="type:pr review:none"

2. 推送标记为"In Progress"但未分配的issues：

console
docker run --rm shibayu36/notify-issues-to-slack \
  -github-token="..." \
  -slack-webhook-url="..." \
  -query="repo:your-org/your-repo label:\"In Progress\" state:open no:assignee" \
  -text="请确认这些任务的负责人"

3. 推送分配给自己的PR审查请求：

console
docker run --rm shibayu36/notify-issues-to-slack \
  -github-token="..." \
  -slack-webhook-url="..." \
  -query="repo:your-org/your-repo state:open type:pr review-requested:your-username"

作者

https://github.com/shibayu36