Skip to content

Commit 2777168

Browse files
committed
Pushing documentation and the ability to release versions of the plugin.
1 parent 95c5a7a commit 2777168

File tree

3 files changed

+35
-1
lines changed

3 files changed

+35
-1
lines changed

README.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Scala modules sbt plugin
2+
This is an sbt plugin for use in defining scala modules. It tries to simplify the act of creating
3+
a scala module build, ensure their are hooks for breaking cycles when doing a "universal rebuild" of the scala ecosystem, and
4+
provide hooks for using the partest testing framework.
5+
6+
7+
# Usage
8+
9+
You must be using sbt 0.13 for your projects. First create a `project/plugins.sbt` files:
10+
11+
addSbtPlugin("org.scala-lang.modules" % "scala-module-plugin" % "0.1")
12+
13+
Then, in your `build.sbt` add:
14+
15+
scalaModuleSettings
16+
17+
name := "<your module name>"
18+
19+
version := "<your module version>"
20+
21+
// standard stuff follows:
22+
scalaVersion := "2.11.0-M5"
23+
24+
// NOTE: not necessarily equal to scalaVersion
25+
// (e.g., during PR validation, we override scalaVersion to validate,
26+
// but don't rebuild scalacheck, so we don't want to rewire that dependency)
27+
scalaBinaryVersion := "2.11.0-M5"

build.sbt

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,13 @@
1+
git.baseVersion := "1.0"
2+
3+
versionWithGit
4+
15
name := "scala-module-plugin"
26

37
organization := "org.scala-lang.modules"
48

59
sbtPlugin := true
610

7-
version := "ZOMG"
11+
publishTo := Some(Resolver.url("sbt-plugin-releases", new URL("http://scalasbt.artifactoryonline.com/scalasbt/sbt-plugin-releases/"))(Resolver.ivyStylePatterns))
12+
13+
publishMavenStyle := false

project/plugins.sbt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
addSbtPlugin("com.typesafe.sbt" % "sbt-git" % "0.6.2")

0 commit comments

Comments
 (0)