Skip to content

Commit f2ca435

Browse files
authored
add dependencies note to readme (#177) (#217)
1 parent 7fcbb7d commit f2ca435

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,19 @@ libraryDependencies += "org.flinkextended" %% "flink-scala-api" % "1.18.1_1.2.0"
8181

8282
Build for Scala 2.12 is no longer published.
8383

84+
## Dependencies management
85+
When including the Scala API in a fat JAR or adding it to the __flink/lib__ folder, users should ensure that the appropriate Scala API dependencies are included
86+
into flink classpath.
87+
In the case of Scala versions, these dependencies should be:
88+
89+
### For Scala 2.13
90+
91+
- [scala-reflect](https://mvnrepository.com/artifact/org.scala-lang/scala-reflect)
92+
- [magnolia](https://mvnrepository.com/artifact/com.softwaremill.magnolia1_2/magnolia_2.13)
93+
94+
### For Scala 3
95+
- [magnolia](https://mvnrepository.com/artifact/com.softwaremill.magnolia1_3/magnolia)
96+
8497
## SBT Project Template
8598

8699
If you want to create new project easily check this __Giter8 template__ out: [novakov-alexey/flink-scala-api.g8](https://github.com/novakov-alexey/flink-scala-api.g8)

0 commit comments

Comments
 (0)