https://github.com/hashmap-kz/relimpact
Release Impact Analyzer for Go projects - make every pull request review easy with automated changelogs for APIs, docs & files.
https://github.com/hashmap-kz/relimpact
changelog ci devops go golang
Last synced: 4 months ago
JSON representation
Release Impact Analyzer for Go projects - make every pull request review easy with automated changelogs for APIs, docs & files.
- Host: GitHub
- URL: https://github.com/hashmap-kz/relimpact
- Owner: hashmap-kz
- License: mit
- Created: 2025-06-08T16:03:19.000Z (8 months ago)
- Default Branch: master
- Last Pushed: 2025-09-15T08:40:17.000Z (5 months ago)
- Last Synced: 2025-09-15T10:31:18.910Z (5 months ago)
- Topics: changelog, ci, devops, go, golang
- Language: Go
- Homepage:
- Size: 143 KB
- Stars: 8
- Watchers: 0
- Forks: 0
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# relimpact
**Release Impact Analyzer for Go projects - catch breaking API changes, docs updates & important file diffs - fast.**
[](https://github.com/hashmap-kz/relimpact/blob/master/LICENSE)
[](https://goreportcard.com/report/github.com/hashmap-kz/relimpact)
[](https://pkg.go.dev/github.com/hashmap-kz/relimpact)
[](https://github.com/hashmap-kz/relimpact/actions/workflows/ci.yml?query=branch:master)
[](https://codecov.io/gh/hashmap-kz/relimpact)
[](https://github.com/hashmap-kz/relimpact/issues)
[](https://github.com/hashmap-kz/relimpact/blob/master/go.mod#L3)
[](https://github.com/hashmap-kz/relimpact/releases/latest)
---
## Features
- **API Diff** – Track breaking public API changes (structs, interfaces, functions, constants, variables) to prevent
surprises for your users.
- **Docs Diff** – Section-aware, heading-aware Markdown diff to highlight meaningful content changes, not noisy line
diffs.
- **Other Files Diff** – Group file changes by extension (.sh, .sql, .json, etc.) to surface important migrations,
scripts, and auxiliary file updates.
- **Designed for Release PR reviews** – Helps reviewers quickly see the real impact of changes at a glance.
- **Human-friendly Markdown Reports** – Ready to paste into GitHub Releases, Slack, or changelogs.
- **Works in GitHub Actions, GitLab CI, or locally** – Integrates easily into your CI pipelines or local release
process.
- **No server required** – Pure CLI tool. No services to deploy or manage - works entirely from your Git repo and
terminal.
---
## Quickstart
### Run on a GitHub PR:
```bash
relimpact --old=v1.0.0 --new=HEAD > release-impact.md
```
### Example Output
**Expanded sections**
**PR Comment Generated**
**See also [docs](./docs) for more examples.**
---
## GitHub Action
```yaml
name: Release Impact on PR
on:
pull_request:
branches: [ master ]
types: [ opened, synchronize, reopened ]
jobs:
release-impact:
name: Generate Release Impact Report
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Determine previous tag
id: prevtag
run: |
git fetch --tags
TAG_LIST=$(git tag --sort=-version:refname)
PREV_TAG=$(echo "$TAG_LIST" | head -n2 | tail -n1)
echo "Previous tag: $PREV_TAG"
# Fallback to first tag if no previous
if [ -z "$PREV_TAG" ]; then
PREV_TAG=$(echo "$TAG_LIST" | head -n1)
echo "Fallback to first tag: $PREV_TAG"
fi
echo "prev_tag=$PREV_TAG" >> $GITHUB_OUTPUT
- name: Determine new ref
id: newref
run: |
if [ "${{ github.event_name }}" = "pull_request" ]; then
echo "new_ref=${{ github.event.pull_request.head.sha }}" >> $GITHUB_OUTPUT
else
echo "new_ref=HEAD" >> $GITHUB_OUTPUT
fi
# Cache restore for old ref
- name: Cache API snapshot (old ref)
uses: actions/cache/restore@v4
id: cache-old
with:
path: .cache/relimpact-api-cache
key: relimpact-api-${{ steps.prevtag.outputs.prev_tag }}
restore-keys: |
relimpact-api-
# Cache restore for new ref
- name: Cache API snapshot (new ref)
uses: actions/cache/restore@v4
id: cache-new
with:
path: .cache/relimpact-api-cache
key: relimpact-api-${{ steps.newref.outputs.new_ref }}
restore-keys: |
relimpact-api-
# Run your relimpact-action (this runs SnapshotAPI and writes cache)
- uses: hashmap-kz/relimpact-action@main
with:
old-ref: ${{ steps.prevtag.outputs.prev_tag }}
new-ref: ${{ steps.newref.outputs.new_ref }}
output: release-impact.md
env:
RELIMPACT_API_CACHE_DIR: ${{ github.workspace }}/.cache/relimpact-api-cache
# Cache save for old ref — only if not already restored
- name: Save API snapshot cache (old ref)
if: steps.cache-old.outputs.cache-hit != 'true'
uses: actions/cache/save@v4
with:
path: .cache/relimpact-api-cache
key: relimpact-api-${{ steps.prevtag.outputs.prev_tag }}
# Cache save for new ref — only if not already restored
- name: Save API snapshot cache (new ref)
if: steps.cache-new.outputs.cache-hit != 'true'
uses: actions/cache/save@v4
with:
path: .cache/relimpact-api-cache
key: relimpact-api-${{ steps.newref.outputs.new_ref }}
# Upload the release impact report
- name: Upload Release Impact Report
uses: actions/upload-artifact@v4
with:
name: release-impact-${{ github.run_id }}-${{ github.run_attempt }}
path: release-impact.md
# Post release impact to PR comment
- name: Post Release Impact to PR
if: github.event_name == 'pull_request'
uses: marocchino/sticky-pull-request-comment@v2
with:
recreate: true
path: release-impact.md
```
---
## Installation
### Docker images are available at [quay.io/hashmap_kz/relimpact](https://quay.io/repository/hashmap_kz/relimpact)
```bash
docker pull quay.io/hashmap_kz/relimpact:latest
```
### Manual Installation
1. Download the latest binary for your platform from
the [Releases page](https://github.com/hashmap-kz/relimpact/releases).
2. Place the binary in your system's `PATH` (e.g., `/usr/local/bin`).
### Installation script for Unix-Based OS _(requires: tar, curl, jq)_:
```bash
(
set -euo pipefail
OS="$(uname | tr '[:upper:]' '[:lower:]')"
ARCH="$(uname -m | sed -e 's/x86_64/amd64/' -e 's/\(arm\)\(64\)\?.*/\1\2/' -e 's/aarch64$/arm64/')"
TAG="$(curl -s https://api.github.com/repos/hashmap-kz/relimpact/releases/latest | jq -r .tag_name)"
curl -L "https://github.com/hashmap-kz/relimpact/releases/download/${TAG}/relimpact_${TAG}_${OS}_${ARCH}.tar.gz" |
tar -xzf - -C /usr/local/bin && \
chmod +x /usr/local/bin/relimpact
)
```
### Homebrew installation
```bash
brew tap hashmap-kz/homebrew-tap
brew install relimpact
```
### Package-Based installation (suitable in CI/CD)
#### Debian
```bash
sudo apt update -y && sudo apt install -y curl
curl -LO https://github.com/hashmap-kz/relimpact/releases/latest/download/relimpact_linux_amd64.deb
sudo dpkg -i relimpact_linux_amd64.deb
```
#### Alpine Linux
```bash
apk update && apk add --no-cache bash curl
curl -LO https://github.com/hashmap-kz/relimpact/releases/latest/download/relimpact_linux_amd64.apk
apk add relimpact_linux_amd64.apk --allow-untrusted
```
---
## Design Notes
`relimpact` helps you understand **what really changed** between Git refs, in a way that is:
> **Human-friendly** / **Structured** / **Noise-free** / **Release-ready**
### 1. Go Source API Changes
- Tracks changes to your **public exported API**:
- `struct` fields
- `interfaces` and their methods
- `functions`
- `methods`
- `constants`
- `variables`
- Built on top of **Go type system and AST parsing**:
- Uses `golang.org/x/tools/go/packages` to understand the real API, not just text diffs.
- **Ignores formatting changes**, reordering, comments -> only tracks semantic API impact.
- Detects **breaking changes**, such as:
- method signature changes
- removed fields
- removed types
- changed constants
- new API elements.
### 2. Markdown Docs Changes
- Tracks changes in **Markdown files**:
- any `.md` in your repo.
- Uses **Markdown AST parsing**:
- Based on `goldmark` parser.
- Understands:
- Headings (added / removed)
- Links (added / removed)
- Images (added / removed)
- **Section-level word count diffs** -> detect real content changes -> not noisy line diffs.
- Provides a **highly readable report**:
- No messy raw `git diff` output.
- Clear "Section X: 142 -> 155 words" style diffs.
- Great for docs-heavy projects and libraries.
### 3. Other Files Changes
- Tracks other file changes, grouped by extension:
- `.sh`, `.sql`, `.json`, `.yaml`, `.conf`, `.ini`, `.txt`, etc.
- Built on top of **Git diff**:
- Uses `git diff --name-status` under the hood.
- Groups files per extension -> clean, easy to review.
---
## License
MIT License. See [LICENSE](./LICENSE) for details.