Skip to content

Latest commit

 

History

History
42 lines (34 loc) · 2.66 KB

README.md

File metadata and controls

42 lines (34 loc) · 2.66 KB
Raw

kafka-flow

Build Status Coverage Status Codacy Badge Version License: MIT

Microsite

https://evolution-gaming.github.io/kafka-flow

cats-effect compatibility

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

Setup

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
)

Release process

The release process is based on Git tags and makes use of 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:

  1. 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
  2. Create a new release in GitHub. Go to the Releases page, click Draft a new release, select Choose a tag, pick the tag you just created
  3. Press Generate release notes. Release title will be automatically filled with the tag name. Change the description if needed
  4. Press Publish release