Skip to main content

Integration with sbt-header

If you use sbt-header for creating/updating your file headers according to your project's license you can benefit from our sbt-github-header module which pre-fills header template with downloaded Github values. To use it, just add the following line to your plugins.sbt file

addSbtPlugin("com.alejandrohdezma" % "sbt-github-header" % "0.11.13")
note

So we don't force a version of sbt-header, it is requested as a "Provided" dependency so you'll need to provide your own version of sbt-header.

What does this integration do?​

Populates the headerLicense setting from sbt-header with values extracted from Github by SbtGithubPlugin:

  • Year: The information stored in yearRange.
  • Copyright Owner: The information stored in copyrightOwner, provided by the own integration plugin. Defaults to organizationName value if there is no value for organizationHomepage or organizationName <organizationHomepage> if there is.

The headerLicenseStyle setting from the HeaderPlugin will be used to set the style of the autogenerated headers.

Example​

For example, given a project with:

  • an Apache-2.0 license...
  • given that the repository start year is 2019...
  • that the organization name is Alejandro Hernández...
  • and the organization homepage is https://github.com/alejandrohdezma

The following headers will be added to every file:

/*
 * Copyright (c) 2019-2024 Alejandro Hernández <https://github.com/alejandrohdezma>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of
 * this software and associated documentation files (the "Software"), to deal in
 * the Software without restriction, including without limitation the rights to
 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
 * the Software, and to permit persons to whom the Software is furnished to do so,
 * subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
 * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
 * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */