https://evolution-gaming.github.io/kafka-flow
Starting from version 1.0.0 the library uses cats-effect 3.
For versions based on cats-effect 2 please check the latest one in 0.x.x series
addSbtPlugin("com.evolution" % "sbt-artifactory-plugin" % "0.0.2")
lazy val version = "4.1.0" // For cats-effect 3 - compatible version, see the latest one in the badge above
// or in Releases page
// lazy val version = "0.12.0" // For cats-effect 2 - compatible version, see the latest one in 'series-0.x.x' branch or in Releases page
libraryDependencies ++= Seq(
"com.evolutiongaming" %% "kafka-flow" % version,
// if you want to use Cassandra for storing persistent state
"com.evolutiongaming" %% "kafka-flow-persistence-cassandra" % version,
// if you want to use Kafka compact topic for storing persistent state
"com.evolutiongaming" %% "kafka-flow-persistence-kafka" % version,
// if you want to use predefined metrics
"com.evolutiongaming" %% "kafka-flow-metrics" % version
)The release process is based on Git tags and makes use of evolution-gaming/scala-github-actions which uses sbt-dynver to automatically obtain the version from the latest Git tag. The flow is defined in .github/workflows/release.yml.
A typical release process is as follows:
- Create and push a new Git tag. The version should be in the format
vX.Y.Z(example:v4.1.0). Example:git tag v4.1.0 && git push origin v4.1.0 - On success, a new GitHub release is automatically created with a calculated diff and auto-generated release notes. You can see it on
Releasespage, change the description if needed - On failure, the tag is deleted from the remote repository. Please note that your local tag isn't deleted, so if the failure is recoverable then you can delete the local tag and try again (an example of unrecoverable failure is successfully publishing only a few of the artifacts to Artifactory which means a new attempt would fail since Artifactory doesn't allow overwriting its contents)