caupain

1.9.1indexed

Keeps Gradle versions catalogs up to date with speed and simplicity, providing update reports without altering dependencies. Offers usage as a command-line tool or Gradle plugin.

JSJVMNative·deezer/caupain

146

Stars

—

Used by

dependents

Health

/ 100

Caupain

GitHub License

\kɔ.pɛ̃\

Your best buddy for keeping versions catalogs up to date!

Demo

What's this ?

Caupain is a tool to help you keep your Gradle versions catalogs up to date. It is fast, simple to use, and provides a simple report to help you know what dependencies you need to update.

Another one ?

Yeah, we know, there's Dependabot, Renovate, refreshVersions or gradle-version-plugins (and probably many more), but Caupain aims to be simple, fast, and not too opinionated.

The main design choice that distinguishes Caupain from the others is that a simple choice has been made: there's only one source of truth, which is the version catalog, and it only handles Maven repositories.

By not plugging itself into Gradle, it avoids the long runtime that comes with having to wait for Gradle resolving the dependencies. It also doesn't force you to do anything, nor changes anything by itself if you don't want it to: it only tells you what the new versions are and where to find info, and lets you deal with the info.

Basically, if you want a tool that's fast and simple to generate an update report for you, then Caupain will be your best buddy !

Ok, I'm sold, how do I use it ?

There are two ways to use Caupain: either as a command line tool, or as a Gradle plugin. See each README for more details.

What does the reports look like ?

Caupain can generate reports in the following formats:

HTML: a simple HTML report that you can open in your browser. It contains the list of updates alongside with infos about them
Markdown: a simple Markdown report that you can use in a Github summary action for example. This very repository actually uses it for its own dependencies updates
Console: a simple console report listing the updates.