Skip to content

Commit 82eceea

Browse files
update with new version scheme
1 parent 49cdeee commit 82eceea

File tree

1 file changed

+7
-9
lines changed

1 file changed

+7
-9
lines changed

README.md

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -56,15 +56,15 @@ val eventStateDescriptor = new ValueStateDescriptor[Option[String]]("event",
5656

5757
`flink-scala-api` is released to Maven-central for 2.13 and 3. For SBT, add this snippet to `build.sbt`:
5858
```scala
59-
libraryDependencies += "org.flinkextended" %% "flink-scala-api" % "1.18.1_1.2.1"
59+
libraryDependencies += "org.flinkextended" %% "flink-scala-api" % "1.2.5"
6060
```
6161

6262
## For Ammonite
6363

6464
```scala
65-
import $ivy.`org.flinkextended::flink-scala-api:1.18.1_1.2.1`
65+
import $ivy.`org.flinkextended::flink-scala-api:1.2.5`
6666
// you might need flink-client too in order to run in the REPL
67-
import $ivy.`org.apache.flink:flink-clients:1.18.1`
67+
import $ivy.`org.apache.flink:flink-clients:1.20.1`
6868
```
6969

7070
## For Scala 2.12
@@ -100,10 +100,8 @@ If you want to create new project easily check this __Giter8 template__ out: [no
100100

101101
## Supported Flink versions
102102

103-
- `flink-scala-api` version consists of Flink version plus Scala API version, for example 1.18.1_1.1.6
104-
- First three numbers correspond to the Flink Version, for example 1.18.1
105-
- Three more numbers is this project version, for example 1.1.6. You should just use the latest available Scala API project version in your project dependency configuration.
106-
- Three major Flink versions are supported. See supported version in the local [release.sh](release.sh) file.
103+
Three latest Flink 1.x and one Flink 2.y versions are supported.
104+
See supported version in the local [ci.yml](.github/workflows/ci.yml) file.
107105

108106
We suggest to remove the official `flink-scala` and `flink-streaming-scala` deprecated dependencies altogether to simplify the migration and do not to mix two flavors of API in the same project. `flink-scala` dependency is embedding Scala version 2.12.7:
109107
- If you keep them, in order to use the Scala version of your choice, remove `scala` package from `classloader.parent-first-patterns.default` Flink's configuration property:
@@ -159,7 +157,7 @@ classes the compile times are quite high.
159157
### Using a POJO-only Flink serialization framework
160158

161159
If you don't want to use built-in Scala serializers for some reasons, you can always fall back to the Flink
162-
[POJO serializer](https://nightlies.apache.org/flink/flink-docs-release-1.15/docs/dev/datastream/fault-tolerance/serialization/types_serialization/#rules-for-pojo-types),
160+
[POJO serializer](https://nightlies.apache.org/flink/flink-docs-release-1.19/docs/dev/datastream/fault-tolerance/serialization/types_serialization/#rules-for-pojo-types),
163161
explicitly calling it:
164162
```scala mdoc:reset-object
165163
import org.apache.flink.api.common.typeinfo.TypeInformation
@@ -461,7 +459,7 @@ sh release.sh
461459
Increment to next SNAPSHOT version and push to Git server:
462460

463461
```bash
464-
RELEASE_PUBLISH=true sbt "; project scala-api; release with-defaults"
462+
RELEASE_PUBLISH=true sbt "; release with-defaults"
465463
```
466464

467465
## License

0 commit comments

Comments
 (0)