SBT plugin for publishing markdown documentation to github pages
This plugin requires sbt 1.0.0+
Create project/plugins.sbt
:
resolvers += "jitpack" at "https://jitpack.io"
libraryDependencies += "com.github.tmtsoftware" % "sbt-docs" % "0.5.0"
Inside build.sbt
, add DocsPlugin
to a subproject:
lazy val docs = project
.in(file("."))
.enablePlugins(DocsPlugin)
.settings(
docsRepo := "https://github.com/tmtsoftware/sbt-docs",
docsParentDir := "sbt-docs",
gitCurrentRepo := "https://github.com/tmtsoftware/sbt-docs"
)
- docsRepo: The remote git repository where documents will be published"
- docsParentDir: Parent directory where generated documentation will be published
- gitCurrentRepo: The remote git repository associated with this project
Run test
for regular unit tests.
Run scripted
for sbt script tests.
- publish your source to GitHub
- Add your plugin to the community plugins list
- Claim your project an Scaladex
- run
sbt clean test scripted
- create git tag with version to publish and push tag and sources to github
- Publish a github release using Github UI