Use avro scope for external avro sources #211
Conversation
Rely on the Avro scope to compile external sources. If avro sources are declared as Compile or Test dependencies, the plugin would automatically recompile sources, leading to duplicated or even conflicting classes.
| { | ||
| "name": "referencedTypeField", | ||
| "type": "com.github.sbt.avro.test.external.Avsc" |
There was a problem hiding this comment.
To support such things, we would need to re-compile the schemas from the compile scope
There was a problem hiding this comment.
So in this case an external schemas lib can have no deps on other schema libs?
Or do we the end-user "just" need to include both external libs?
There was a problem hiding this comment.
we can (it is done in the Compile scope).
here we want the schemas in the test scope to depend on some other schema from the compile. To do so, we need to parse those again.
| @@ -52,12 +52,14 @@ lazy val root: Project = project | |||
| name := "publishing-test", | |||
| crossScalaVersions := Seq("2.13.15", "2.12.20"), | |||
| libraryDependencies ++= Seq( | |||
| "com.github.sbt" % "transitive" % "0.0.1-SNAPSHOT" classifier "avro", | |||
| "com.github.sbt" % "transitive" % "0.0.1-SNAPSHOT" % Test classifier "tests", | |||
| "com.github.sbt" % "external" % "0.0.1-SNAPSHOT" % "avro" classifier "avro", // must be explicit | |||
There was a problem hiding this comment.
with avro scope, libs are not fetched transitively.
| @@ -103,15 +103,23 @@ Compile / packageAvro / publishArtifact := true | |||
| You can specify a dependency on an avro source artifact that contains the schemas like so: | |||
|
|
|||
| ```sbt | |||
| libraryDependencies += "org" % "name" % "rev" classifier "avro" | |||
| libraryDependencies += "org" % "name" % "rev" % "avro" classifier "avro" | |||
There was a problem hiding this comment.
If people use the previous dependency declaration will the transitively included deps be compiled into the current artifact?
There was a problem hiding this comment.
there are 2 cases when user update to sbt-avro v4 :
- if they require the schemas to be compiled: compilation fails unless user changes the dep scope to
avro(or update the include filter) - if one lib pulls an undesired
avroclassifier artifact, the plugin won't re-compile the schemas (we assume the jar pulling the schema already includes compiled classes)
Rely on the Avro scope to compile external sources by default.
When avro sources are declared as Compile or Test dependencies, those would be fetched when depending on the default artifact (no avro classifier). The default artifact usually contains the java generated classes, hence the the plugin should not automatically recompile those.