-
Notifications
You must be signed in to change notification settings - Fork 138
/
build.sbt
242 lines (224 loc) · 8.63 KB
/
build.sbt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
import sbt.Def
import MimaSettings.mimaSettings
import scala.sys.process._
import scala.util.Try
/**
* As of zio-kafka version 2.8.0 releases are binary compatible. This is checked with Mima.
*
* Keep this value set to the oldest minor release (with patch version set to "0") that is still binary compatible.
*
* Set this value to `None` when master is _not_ binary compatible with the latest minor release, the next release shall
* increase the minor version.
*/
lazy val binCompatVersionToCompare =
// Note, "git describe --tags"
// either produces something like "v2.8.2-40-ge8a844a1" (not building from a release tag),
// or "v2.8.2" (building from a release tag),
Try("git describe --tags".!!).toOption
.map(_.strip())
// Only continue when we're building from a release tag
.filter(_.matches("v[0-9]+\\.[0-9]+\\.[0-9]+"))
.map { tag =>
// Remove `v` and set patch version to `0`
val compatVersion = tag.stripPrefix("v").split('.').take(2).mkString(".") + ".0"
println(s"Mima check compares against version $compatVersion")
compatVersion
}
lazy val kafkaVersion = "3.8.1"
lazy val embeddedKafkaVersion = "3.8.1" // Should be the same as kafkaVersion, except for the patch part
lazy val kafkaClients = "org.apache.kafka" % "kafka-clients" % kafkaVersion
lazy val logback = "ch.qos.logback" % "logback-classic" % "1.5.12"
enablePlugins(ZioSbtEcosystemPlugin, ZioSbtCiPlugin)
lazy val _scala213 = "2.13.15"
lazy val _scala3 = "3.3.4"
inThisBuild(
List(
name := "ZIO Kafka",
zioVersion := "2.1.12",
scalaVersion := _scala213,
// zio-sbt defines these 'scala213' and 'scala3' settings, but we need to define them here to override the defaults and better control them
scala213 := _scala213,
scala3 := _scala3,
// We only support Scala 2.13+ and 3+. See https://github.com/zio/zio-kafka/releases/tag/v2.7.0
crossScalaVersions := List(scala213.value, scala3.value),
ciEnabledBranches := Seq("master", "series/0.x"),
useCoursier := false,
Test / parallelExecution := false,
Test / fork := true,
run / fork := true,
ciJvmOptions ++= Seq("-Xms6G", "-Xmx6G", "-Xss4M", "-XX:+UseG1GC"),
scalafixDependencies ++= List(
"com.github.vovapolu" %% "scaluzzi" % "0.1.23",
"io.github.ghostbuster91.scalafix-unified" %% "unified" % "0.0.9"
),
developers := List(
Developer(
"iravid",
"Itamar Ravid",
"iravid@iravid.com",
url("https://github.com/iravid")
),
Developer(
"svroonland",
"svroonland",
"",
url("https://github.com/svroonland")
),
Developer(
"guizmaii",
"Jules Ivanic",
"",
url("https://github.com/guizmaii")
),
Developer(
"erikvanoosten",
"Erik van Oosten",
"",
url("https://github.com/erikvanoosten")
)
)
)
)
val excludeInferAny = { options: Seq[String] => options.filterNot(Set("-Xlint:infer-any")) }
lazy val root = project
.in(file("."))
.settings(
name := "zio-kafka",
publish / skip := true,
crossScalaVersions := Nil, // https://www.scala-sbt.org/1.x/docs/Cross-Build.html#Cross+building+a+project+statefully,
commands += lint
)
.aggregate(
zioKafka,
zioKafkaTestkit,
zioKafkaTest,
zioKafkaBench,
zioKafkaExample,
docs
)
def stdSettings(prjName: String) = Seq(
name := s"$prjName",
scalafmtOnCompile := !insideCI.value,
Compile / compile / scalacOptions ++=
optionsOn("2.13")("-Wconf:cat=unused-nowarn:s").value,
scalacOptions -= "-Xlint:infer-any",
// workaround for bad constant pool issue
(Compile / doc) := Def.taskDyn {
val default = (Compile / doc).taskValue
Def.task(default.value)
}.value,
libraryDependencies ++= {
CrossVersion.partialVersion(scalaVersion.value) match {
case Some((2, _)) => Seq(compilerPlugin("com.olegpy" %% "better-monadic-for" % "0.3.1"))
case _ => List.empty
}
}
) ++ scalafixSettings
lazy val zioKafka =
project
.in(file("zio-kafka"))
.enablePlugins(BuildInfoPlugin)
.settings(stdSettings("zio-kafka"))
.settings(buildInfoSettings("zio.kafka"))
.settings(mimaSettings(binCompatVersionToCompare, failOnProblem = true))
.settings(enableZIO(enableStreaming = true))
.settings(
libraryDependencies ++= Seq(kafkaClients)
)
lazy val `embedded-kafka`: Def.Initialize[Seq[sbt.ModuleID]] = {
val embeddedKafka = "io.github.embeddedkafka" %% "embedded-kafka" % embeddedKafkaVersion
dependenciesOnOrElse("3")(
embeddedKafka
.cross(CrossVersion.for3Use2_13) exclude ("org.scala-lang.modules", "scala-collection-compat_2.13")
)(embeddedKafka)
}
lazy val zioKafkaTestkit =
project
.in(file("zio-kafka-testkit"))
.dependsOn(zioKafka)
.enablePlugins(BuildInfoPlugin)
.settings(stdSettings("zio-kafka-testkit"))
.settings(mimaSettings(binCompatVersionToCompare, failOnProblem = false))
.settings(
libraryDependencies ++= Seq(
"dev.zio" %% "zio" % zioVersion.value,
"dev.zio" %% "zio-test" % zioVersion.value,
kafkaClients
) ++ `embedded-kafka`.value
)
lazy val zioKafkaTest =
project
.in(file("zio-kafka-test"))
.dependsOn(zioKafka, zioKafkaTestkit)
.enablePlugins(BuildInfoPlugin)
.settings(stdSettings("zio-kafka-test"))
.settings(buildInfoSettings("zio.kafka"))
.settings(enableZIO(enableStreaming = true))
.settings(publish / skip := true)
.settings(
libraryDependencies ++= Seq(
kafkaClients,
logback % Test,
"dev.zio" %% "zio-logging-slf4j" % "2.3.2" % Test
) ++ `embedded-kafka`.value
)
lazy val zioKafkaBench =
project
.in(file("zio-kafka-bench"))
.enablePlugins(JmhPlugin)
.settings(stdSettings("zio-kafka-bench"))
.settings(publish / skip := true)
.settings(libraryDependencies += logback)
.dependsOn(zioKafka, zioKafkaTestkit)
lazy val zioKafkaExample =
project
.in(file("zio-kafka-example"))
.enablePlugins(JavaAppPackaging)
// The `dependsOn` pulls in:
// "dev.zio" %% "zio-kafka" % "version",
// "dev.zio" %% "zio-kafka-testkit" % "version" % Test,
.dependsOn(zioKafka, zioKafkaTestkit % "test")
.settings(stdSettings("zio-kafka-example"))
.settings(publish / skip := true)
.settings(run / fork := false)
.settings(
libraryDependencies ++= Seq(
"dev.zio" %% "zio" % zioVersion.value,
"dev.zio" %% "zio-logging-slf4j2" % "2.3.2",
"io.github.embeddedkafka" %% "embedded-kafka" % embeddedKafkaVersion,
logback,
"dev.zio" %% "zio-test" % zioVersion.value % Test
),
// Scala 3 compiling fails with:
// [error] Modules were resolved with conflicting cross-version suffixes in ProjectRef(uri("file:/home/runner/work/zio-kafka/zio-kafka/"), "zioKafkaExample"):
// [error] org.scala-lang.modules:scala-collection-compat _3, _2.13
// Prevent this error by excluding "scala-collection-compat" (see zio-kafka docs),
// or by skipping scala 3 completely.
crossScalaVersions -= scala3.value
)
addCommandAlias("fmt", "all scalafmtSbt scalafmt test:scalafmt")
addCommandAlias("check", "all scalafmtSbtCheck scalafmtCheck test:scalafmtCheck")
addCommandAlias("mimaCheck", "+zioKafka/mimaReportBinaryIssues;+zioKafkaTestkit/mimaReportBinaryIssues")
lazy val docs = project
.in(file("zio-kafka-docs"))
.settings(
moduleName := "zio-kafka-docs",
scalacOptions -= "-Yno-imports",
scalacOptions -= "-Xfatal-warnings",
projectName := "ZIO Kafka",
mainModuleName := (zioKafka / moduleName).value,
projectStage := ProjectStage.ProductionReady,
ScalaUnidoc / unidoc / unidocProjectFilter := inProjects(zioKafka),
readmeCredits :=
"This library is heavily inspired and made possible by the research and implementation done in " +
"[Alpakka Kafka](https://github.com/akka/alpakka-kafka), a library maintained by the Akka team and originally " +
"written as Reactive Kafka by SoftwareMill.",
readmeLicense += s"\n\nCopyright 2021-${java.time.Year.now()} Itamar Ravid and the zio-kafka contributors."
)
.enablePlugins(WebsitePlugin)
.dependsOn(zioKafka, zioKafkaTestkit)
// Extend 'lint' with mimaCheck
lazy val lint = {
val defaultLint = zio.sbt.Commands.ComposableCommand.lint
defaultLint.copy(commandStrings = defaultLint.commandStrings :+ "mimaCheck").toCommand
}