alejandrohdezma / sbt-me

SBT plugin to read several settings from Github

GitHub

SBT plugin to read several settings from Github

This plugin enables several settings automatically by downloaded them from Github:

  • organization: Retrieved from the current Github user's email (e.g. info@alejandrohdezma.com => com.alejandrohdezma).
  • homepage: Retrieved from the Github repository's information.
  • developers: A list containing the current Github user information.
  • description: Retrieved from the Github repository.
  • licenses: Retrieved from the Github repository.

Installation

Add the following line to your plugins.sbt file:

addSbtPlugin("com.alejandrohdezma" %% "sbt-me" % "0.3.0")

Configuration

By default, the plugin only downloads the information if an environment variable named RELEASE is present in the system SBT is running (the content of the variable is not important). This behaviour can be tweaked by using the downloadInfoFromGithub setting:

downloadInfoFromGithub := true

Github API token

In order for this plugin to work you'll need to add an environment variable named GITHUB_PERSONAL_ACCESS_TOKEN with a personal access content.