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:
- The original idea by @rkuhn who came up with authors.pl using now unknown archaic language
- The rewrite of the original script by @johanandren who gave us the magnificent authors.scala
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.3")
sbt-authors
is an AutoPlugin and therefore that is all that is required.
-
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 betweenv0.20
andv0.21
git tagsauthors v0.20 HEAD
- summary betweenv0.20
tag and the last commit -
authorsFile <from> <to>
Writes the same authors summary to atarget/authors.md
file. -
authorsClipboard <from> <to>
Puts the same authors summary to your clipboard.
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.