relimpact

项目概述

relimpact 是一个快速生成 Go 项目 API 兼容性报告的工具。它比较两个 Git 引用（如标签或提交），快照导出的 Go API，并报告变更——破坏性变更优先显示。

主要功能

• 比较两个 Git 引用并生成 API 兼容性报告
• 突出显示破坏性变更，兼容性变更放在下方
• 支持 Markdown 和 HTML 两种输出格式
• 支持对比另一个仓库
• 支持最大并发
• 提供 GitHub Actions 集成，可自动在 PR 中评论报告

适用人群

• Go 开发者
• 需要维护 API 兼容性的库作者
• DevOps 工程师（CI 集成）

快速上手

1. 安装：go install github.com/hashmap-kz/relimpact@latest
2. 或通过 Homebrew：brew install relimpact
3. 生成 Markdown 报告：relimpact --old=v1.0.0 --new=HEAD > api-report.md
4. 生成 HTML 报告：relimpact --old=v1.0.0 --new=HEAD --format=html > api-report.html

核心优势

• 专注于 API 兼容性问题，不是 diff 工具或变更日志生成器
• 破坏性变更优先显示
• GitHub Actions 原生集成

系统要求

• 操作系统：跨平台
• 支持架构：amd64、arm64