From 5e6c6c8680ea18bfda6500326294887b59449d67 Mon Sep 17 00:00:00 2001 From: Daniel Spiewak Date: Sat, 24 Jun 2023 14:21:45 -0500 Subject: [PATCH] Update versions for 3.5.1 --- README.md | 12 ++++++------ docs/core/native-image.md | 2 +- docs/core/scala-native.md | 2 +- docs/core/test-runtime.md | 2 +- docs/getting-started.md | 2 +- docs/migration-guide.md | 8 ++++---- docs/tutorial.md | 4 ++-- 7 files changed, 16 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 6c069787f1..b182c620d1 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ - Tired: **2.5.5** (end of life) ```scala -libraryDependencies += "org.typelevel" %% "cats-effect" % "3.5.0" +libraryDependencies += "org.typelevel" %% "cats-effect" % "3.5.1" ``` 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.0", - "org.typelevel" %% "cats-effect-laws" % "3.5.0" % Test) + "org.typelevel" %% "cats-effect-kernel" % "3.5.1", + "org.typelevel" %% "cats-effect-laws" % "3.5.1" % 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.0", - "org.typelevel" %% "cats-effect" % "3.5.0" % Test) + "org.typelevel" %% "cats-effect-std" % "3.5.1", + "org.typelevel" %% "cats-effect" % "3.5.1" % 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.0" % Test +libraryDependencies += "org.typelevel" %% "cats-effect-testkit" % "3.5.1" % 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 2e2a5d7684..237a70351a 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.0", + libraryDependencies += "org.typelevel" %% "cats-effect" % "3.5.1", 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 7eb9bcfa0d..d146d72fb4 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.0", + libraryDependencies += "org.typelevel" %%% "cats-effect" % "3.5.1", Compile / mainClass := Some("com.example.Main") ) diff --git a/docs/core/test-runtime.md b/docs/core/test-runtime.md index 58c8e741f7..be1e17f199 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.0" % Test +libraryDependencies += "org.typelevel" %% "cats-effect-testkit" % "3.5.1" % Test ``` ## Example diff --git a/docs/getting-started.md b/docs/getting-started.md index 3b00d80507..8ad0bc3fe6 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.0" +libraryDependencies += "org.typelevel" %% "cats-effect" % "3.5.1" ``` 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: diff --git a/docs/migration-guide.md b/docs/migration-guide.md index 32772d1fd7..9fa8838271 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.0", -"org.typelevel" %% "cats-effect-std" % "3.5.0", -"org.typelevel" %% "cats-effect" % "3.5.0", +"org.typelevel" %% "cats-effect-kernel" % "3.5.1", +"org.typelevel" %% "cats-effect-std" % "3.5.1", +"org.typelevel" %% "cats-effect" % "3.5.1", ``` - `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.0", ++ "org.typelevel" %% "cats-effect" % "3.5.1", //... ) ``` diff --git a/docs/tutorial.md b/docs/tutorial.md index 1073150b6d..89d3ca7781 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.0" +version := "3.5.1" scalaVersion := "2.13.6" -libraryDependencies += "org.typelevel" %% "cats-effect" % "3.5.0" withSources() withJavadoc() +libraryDependencies += "org.typelevel" %% "cats-effect" % "3.5.1" withSources() withJavadoc() scalacOptions ++= Seq( "-feature",