sbt-circe-org

This project is intended to set up sensible defaults and standards for projects under io.circe. If it's useful outside io.circe, it probably should be pushed further upstream into sbt-typelevel.

Installing it

The plugin is deployed to Sonatype.

addSbtPlugin("io.circe" % "sbt-circe-org" % "@VERSION@")

What does it do?

CirceOrgPlugin

Triggers automatically. Use on all published circe modules.

• Activates the sensible defaults of sbt-typelevel
• Sets the organization info
• Enables automated license headers with appropriate years
• Enables sbt-github-actions with settings appropriate to our workflow
• by default does not run code coverage in all io.circe.examples.* packages

CirceOrgSitePlugin

Must be manually triggered. Extends the TypelevelSitePlugin with the circe.io theme. See the sbt-typelevel-site docs for usage.

Provided images

You can refer to the following images in customizing the laika theme:

• Path.Root / "images" / "circe_dark.svg"
• Path.Root / "images" / "circe_light_no_border.svg"
• Path.Root / "images" / "circe_light_no_border_146x173.png"