2m / authors

Get a nicely formatted summary of authors that contributed to a project between two points in git history

GitHub

sbt-authors scaladex-badge travis-badge gitter-badge

authors is a CLI application and an sbt plugin that produces a nicely formatted summary of authors that contributed to a project between two points in git history.

Inspired by:

asciicast-badge

Usage of the sbt plugin

Add this to your sbt build plugins, in either project/plugins.sbt or ~/.sbt/1.0/plugins/build.sbt:

addSbtPlugin("lt.dvim.authors" % "sbt-authors" % "1.2")
resolvers += Resolver.bintrayRepo("jypma", "maven") // for ts-reaktive

sbt-authors is an AutoPlugin and therefore that is all that is required.

Tasks

  • authors <from> <to> Fetches the authors summary between two points in git history and prints it to stdout. For example:

    authors v0.20 v0.21 - summary between v0.20 and v0.21 git tags

    authors v0.20 HEAD - summary between v0.20 tag and the last commit

  • authorsFile <from> <to> Writes the same authors summary to a target/authors.md file.

  • authorsClipboard <from> <to> Puts the same authors summary to your clipboard.

Usage of the CLI tool

Use coursier to install and launch authors directly.

cs install --contrib authors

Then go to the checkedout folder of your project repository and run the foillowing.

authors v1.1 v1.2

This will fetch the summary between the two tags, which will be printed to the stdout.