A bot that comments on a Change Request with updated dependencies
  • Go 99.5%
  • Makefile 0.4%
Find a file
Repository files (latest commit first)
Filename Latest commit message Latest commit date
Jérémy DECOOL 5e234adc6f
Merge pull request #9 from jdecool/reorganize-readme-and-docs
Reorganize README into a lean landing page and move docs into docs/
2026-07-23 21:39:27 +02:00
.claude/rules Initial commit 2026-07-16 23:23:49 +02:00
.github/workflows Fix GHA workflow for tag releases 2026-07-18 16:47:14 +02:00
cmd/dependency-diff-notes Add a Report Fold option controlling how much of the report starts collapsed 2026-07-21 07:44:16 +02:00
docs Reorganize README into a lean landing page and move docs into docs/ 2026-07-23 21:38:06 +02:00
examples Add npm ecosystem support alongside Composer 2026-07-18 08:50:09 +02:00
internal Add a Report Fold option controlling how much of the report starts collapsed 2026-07-21 07:44:16 +02:00
.gitignore Initial commit 2026-07-16 23:23:49 +02:00
.goreleaser.yaml Initial commit 2026-07-16 23:23:49 +02:00
CLAUDE.md Add Yarn ecosystem support alongside Composer, npm, and pnpm 2026-07-18 10:00:33 +02:00
CONTEXT.md Add a Report Fold option controlling how much of the report starts collapsed 2026-07-21 07:44:16 +02:00
Dockerfile Initial commit 2026-07-16 23:23:49 +02:00
go.mod Detect upgrade and downgrade direction on dependency updates 2026-07-20 21:16:36 +02:00
go.sum Detect upgrade and downgrade direction on dependency updates 2026-07-20 21:16:36 +02:00
Makefile Initial commit 2026-07-16 23:23:49 +02:00
README.md Reorganize README into a lean landing page and move docs into docs/ 2026-07-23 21:38:06 +02:00

Dependency Diff Notes Bot

A bot that comments on a Change Request with updated dependencies.

It inspects a project's dependency state, determines what changed, and posts a single comment on the corresponding GitLab merge request or GitHub pull request reporting them.

Supported ecosystems: Composer (PHP), reading from composer.lock; npm (JavaScript), reading from package-lock.json; pnpm (JavaScript), reading from pnpm-lock.yaml; and Yarn (JavaScript), reading from yarn.lock. A project using more than one at once (e.g. a Composer backend and an npm frontend) gets a single comment with one section per ecosystem — see Ecosystem notes.

Installation

go install github.com/jdecool/dependency-diff-notes/cmd/dependency-diff-notes@latest

Or download a prebuilt binary from the releases page.

A Docker image is also published to ghcr.io/jdecool/dependency-diff-notes on every release (:<version> and :latest, linux/amd64 and linux/arm64).

Quick start

In a CI pipeline the bot posts its report as a comment on the Change Request; run from a terminal it prints the same report to stdout. The active Forge is detected automatically from the CI environment — GitHub Actions always sets GITHUB_ACTIONS=true; anything else is treated as GitLab — so no flag is needed to select one.

What the comment looks like

Each ecosystem gets its own heading and a collapsible section holding one table per dependency group, with added, removed, upgraded, downgraded, and changed packages listed alphabetically:

## Dependency changes

### Composer

| Package | Change | Version |
|---|---|---|
| symfony/console | ⬆️ Upgraded | v6.4.2 → v6.4.3 |
| phpunit/phpunit | ➕ Added | 10.5.9 |

See Understanding the report for the full anatomy and how the Change column is decided.

Documentation

Full documentation lives in docs/index.md: setup and usage guides, the complete configuration reference, report options, ecosystem notes, and architecture decisions.

Development

make build      # build the binary into dist/
make run        # run without building
make test       # run tests
make coverage   # run tests with coverage (HTML + JUnit reports)