From a9b8d11e0ae46293893f6e5b1486f96f0238749e Mon Sep 17 00:00:00 2001 From: Daniel Spiewak Date: Wed, 6 Mar 2024 09:40:53 -0600 Subject: [PATCH] Update versions for 3.5.4 --- README.md | 14 +++++++------- docs/core/native-image.md | 2 +- docs/core/scala-native.md | 2 +- docs/core/test-runtime.md | 2 +- docs/faq.md | 2 +- docs/getting-started.md | 4 ++-- docs/migration-guide.md | 8 ++++---- docs/std/mapref.md | 2 +- docs/std/ref.md | 2 +- docs/tutorial.md | 4 ++-- 10 files changed, 21 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index bfe0f4b4f5..bbabf866ec 100644 --- a/README.md +++ b/README.md @@ -11,11 +11,11 @@ ## Getting Started -- Wired: **3.5.3** +- Wired: **3.5.4** - Tired: **2.5.5** (end of life) ```scala -libraryDependencies += "org.typelevel" %% "cats-effect" % "3.5.3" +libraryDependencies += "org.typelevel" %% "cats-effect" % "3.5.4" ``` The above represents the core, stable dependency which brings in the entirety of Cats Effect. This is *most likely* what you want. All current Cats Effect releases are published for Scala 2.12, 2.13, 3.0, and Scala.js 1.7. @@ -30,22 +30,22 @@ Depending on your use-case, you may want to consider one of the several other mo ```scala libraryDependencies ++= Seq( - "org.typelevel" %% "cats-effect-kernel" % "3.5.3", - "org.typelevel" %% "cats-effect-laws" % "3.5.3" % Test) + "org.typelevel" %% "cats-effect-kernel" % "3.5.4", + "org.typelevel" %% "cats-effect-laws" % "3.5.4" % Test) ``` If you're a middleware framework (like [Fs2](https://fs2.io/)), you probably want to depend on **std**, which gives you access to `Queue`, `Semaphore`, and much more without introducing a hard-dependency on `IO` outside of your tests: ```scala libraryDependencies ++= Seq( - "org.typelevel" %% "cats-effect-std" % "3.5.3", - "org.typelevel" %% "cats-effect" % "3.5.3" % Test) + "org.typelevel" %% "cats-effect-std" % "3.5.4", + "org.typelevel" %% "cats-effect" % "3.5.4" % Test) ``` You may also find some utility in the **testkit** and **kernel-testkit** projects, which contain `TestContext`, generators for `IO`, and a few other things: ```scala -libraryDependencies += "org.typelevel" %% "cats-effect-testkit" % "3.5.3" % Test +libraryDependencies += "org.typelevel" %% "cats-effect-testkit" % "3.5.4" % Test ``` Cats Effect provides backward binary compatibility within the 2.x and 3.x version lines, and both forward and backward compatibility within any major/minor line. This is analogous to the versioning scheme used by Cats itself, as well as other major projects such as Scala.js. Thus, any project depending upon Cats Effect 2.2.1 can be used with libraries compiled against Cats Effect 2.0.0 or 2.2.3, but *not* with libraries compiled against 2.3.0 or higher. diff --git a/docs/core/native-image.md b/docs/core/native-image.md index 3a29e30c9a..0d033c68e9 100644 --- a/docs/core/native-image.md +++ b/docs/core/native-image.md @@ -33,7 +33,7 @@ ThisBuild / scalaVersion := "2.13.8" lazy val root = (project in file(".")).enablePlugins(NativeImagePlugin).settings( name := "cats-effect-3-hello-world", - libraryDependencies += "org.typelevel" %% "cats-effect" % "3.5.3", + libraryDependencies += "org.typelevel" %% "cats-effect" % "3.5.4", Compile / mainClass := Some("com.example.Main"), nativeImageOptions += "--no-fallback", nativeImageVersion := "22.1.0" // It should be at least version 21.0.0 diff --git a/docs/core/scala-native.md b/docs/core/scala-native.md index caaa355101..0d5118e7d7 100644 --- a/docs/core/scala-native.md +++ b/docs/core/scala-native.md @@ -22,7 +22,7 @@ lazy val root = project.in(file(".")) .enablePlugins(ScalaNativePlugin) .settings( name := "cats-effect-3-hello-world", - libraryDependencies += "org.typelevel" %%% "cats-effect" % "3.5.3", + libraryDependencies += "org.typelevel" %%% "cats-effect" % "3.5.4", Compile / mainClass := Some("com.example.Main") ) diff --git a/docs/core/test-runtime.md b/docs/core/test-runtime.md index cb5adfb29d..b321d5ffb4 100644 --- a/docs/core/test-runtime.md +++ b/docs/core/test-runtime.md @@ -28,7 +28,7 @@ For those migrating code from Cats Effect 2, `TestControl` is a considerably mor In order to use `TestControl`, you will need to bring in the **cats-effect-testkit** dependency: ```scala -libraryDependencies += "org.typelevel" %% "cats-effect-testkit" % "3.5.3" % Test +libraryDependencies += "org.typelevel" %% "cats-effect-testkit" % "3.5.4" % Test ``` ## Example diff --git a/docs/faq.md b/docs/faq.md index 4a7c1b40e6..3440b60b15 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -9,7 +9,7 @@ title: FAQ ```scala-cli //> using scala "2.13.8" -//> using lib "org.typelevel::cats-effect::3.5.3" +//> using lib "org.typelevel::cats-effect::3.5.4" import cats.effect._ diff --git a/docs/getting-started.md b/docs/getting-started.md index 4241e338dd..3259cbc652 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -6,7 +6,7 @@ title: Getting Started Add the following to your **build.sbt**: ```scala -libraryDependencies += "org.typelevel" %% "cats-effect" % "3.5.3" +libraryDependencies += "org.typelevel" %% "cats-effect" % "3.5.4" ``` Naturally, if you're using ScalaJS, you should replace the double `%%` with a triple `%%%`. If you're on Scala 2, it is *highly* recommended that you enable the [better-monadic-for](https://github.com/oleg-py/better-monadic-for) plugin, which fixes a number of surprising elements of the `for`-comprehension syntax in the Scala language: @@ -62,7 +62,7 @@ We will learn more about constructs like `start` and `*>` in later pages, but fo Of course, the easiest way to play with Cats Effect is to try it out in a Scala REPL. We recommend using [Ammonite](https://ammonite.io/#Ammonite-REPL) for this kind of thing. To get started, run the following lines (if not using Ammonite, skip the first line and make sure that Cats Effect and its dependencies are correctly configured on the classpath): ```scala -import $ivy.`org.typelevel::cats-effect:3.5.3` +import $ivy.`org.typelevel::cats-effect:3.5.4` import cats.effect.unsafe.implicits._ import cats.effect.IO diff --git a/docs/migration-guide.md b/docs/migration-guide.md index e4d19a705c..1f1eb9f6c2 100644 --- a/docs/migration-guide.md +++ b/docs/migration-guide.md @@ -81,9 +81,9 @@ Cats Effect 3 splits the code dependency into multiple modules. If you were prev The current non-test modules are: ```scala -"org.typelevel" %% "cats-effect-kernel" % "3.5.3", -"org.typelevel" %% "cats-effect-std" % "3.5.3", -"org.typelevel" %% "cats-effect" % "3.5.3", +"org.typelevel" %% "cats-effect-kernel" % "3.5.4", +"org.typelevel" %% "cats-effect-std" % "3.5.4", +"org.typelevel" %% "cats-effect" % "3.5.4", ``` - `kernel` - type class definitions, simple concurrency primitives @@ -96,7 +96,7 @@ The current non-test modules are: libraryDependencies ++= Seq( //... - "org.typelevel" %% "cats-effect" % "2.4.0", -+ "org.typelevel" %% "cats-effect" % "3.5.3", ++ "org.typelevel" %% "cats-effect" % "3.5.4", //... ) ``` diff --git a/docs/std/mapref.md b/docs/std/mapref.md index cff4da3eb8..39fee799fd 100644 --- a/docs/std/mapref.md +++ b/docs/std/mapref.md @@ -32,7 +32,7 @@ as long as their keys belong to different shards. This is probably one of the most common uses of this datatype. ```scala mdoc:reset:silent -//> using lib "org.typelevel::cats-effect::3.5.3" +//> using lib "org.typelevel::cats-effect::3.5.4" import cats.effect.IO import cats.effect.std.MapRef diff --git a/docs/std/ref.md b/docs/std/ref.md index 35f3c7c62a..e4d69dc230 100644 --- a/docs/std/ref.md +++ b/docs/std/ref.md @@ -33,7 +33,7 @@ This is probably one of the most common uses of this concurrency primitive. In this example, the workers will concurrently run and update the value of the `Ref`. ```scala mdoc:reset:silent -//> using lib "org.typelevel::cats-effect::3.5.3" +//> using lib "org.typelevel::cats-effect::3.5.4" import cats.effect.{IO, IOApp, Sync} import cats.effect.kernel.Ref diff --git a/docs/tutorial.md b/docs/tutorial.md index 2a330585b3..62b66353b8 100644 --- a/docs/tutorial.md +++ b/docs/tutorial.md @@ -42,11 +42,11 @@ running the code snippets in this tutorial, it is recommended to use the same ```scala name := "cats-effect-tutorial" -version := "3.5.3" +version := "3.5.4" scalaVersion := "2.13.13" -libraryDependencies += "org.typelevel" %% "cats-effect" % "3.5.3" withSources() withJavadoc() +libraryDependencies += "org.typelevel" %% "cats-effect" % "3.5.4" withSources() withJavadoc() scalacOptions ++= Seq( "-feature",