femtopixel/github-release-notifier

GitHub Release Notifier 镜像文档

镜像概述

GitHub Release Notifier 是一个轻量级工具，旨在帮助用户实时接收 GitHub 项目的新版本发布通知。该镜像支持多架构部署，通过 Docker 容器化运行，提供简单的订阅机制和数据持久化功能，适用于需要跟踪 GitHub 项目更新的开发者和团队。

核心功能与特性

• 实时版本监控：自动检测指定 GitHub 项目的新版本发布
• Webhook 集成：支持通过 Webhook URL 接收通知，便于集成到现有工作流
• 数据持久化：可挂载卷保存 Webhook 配置和版本跟踪记录，确保数据不丢失
• 多架构支持：适配多种硬件架构，提升部署灵活性
• 简单命令行操作：通过容器命令快速完成项目订阅和配置管理

使用场景与适用范围

适用于以下场景：

• 开发者监控依赖库或工具的新版本发布
• 团队跟踪协作项目的迭代更新
• 自动化流程中集成版本更新触发机制
• 开源项目爱好者获取关注仓库的最新动态

使用方法与配置说明

基本部署

使用以下命令启动容器（后台运行）：

bash
docker run --name GRN -d femtopixel/github-release-notifier

持久化配置

为确保 Webhook 配置和版本跟踪数据不丢失，建议挂载本地目录到容器内的 /root/.github_release_notifier/ 路径：

bash
docker run --name GRN -d -v /path/to/local/saves:/root/.github_release_notifier/ femtopixel/github-release-notifier

订阅 GitHub 项目

通过 docker exec 命令在运行的容器中注册项目订阅，格式如下：

bash
docker exec GRN -a subscribe -p <GitHub项目路径> -w <Webhook通知URL>

参数说明：

• -a subscribe：指定操作类型为订阅
• -p：GitHub 项目完整路径（格式：用户名/仓库名，例如 jaymoulin/google-music-manager）
• -w：接收通知的 Webhook 端点 URL（例如 https://your-domain.com/webhook-endpoint）

问题反馈与支持

Bug 报告和功能请求请通过 http://github.com/femtopixel/github-release-notifier/issues 提交。

作者与许可证

• 作者：Jay MOULIN（：）
• 贡献者：参见 http://github.com/femtopixel/github-release-notifier
• 许可证：MIT 许可证