Skip to content

Commit

Permalink
Merge pull request #2936 from djspiewak/release/3.3.10-minor
Browse files Browse the repository at this point in the history
Updated versions for 3.3.10
  • Loading branch information
djspiewak authored Apr 4, 2022
2 parents fad0540 + 6783e44 commit 913367b
Show file tree
Hide file tree
Showing 5 changed files with 19 additions and 19 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,11 @@

## Getting Started

- Wired: **3.3.9**
- Wired: **3.3.10**
- Tired: **2.5.4**

```scala
libraryDependencies += "org.typelevel" %% "cats-effect" % "3.3.9"
libraryDependencies += "org.typelevel" %% "cats-effect" % "3.3.10"
```

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.
Expand All @@ -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.3.9",
"org.typelevel" %% "cats-effect-laws" % "3.3.9" % Test)
"org.typelevel" %% "cats-effect-kernel" % "3.3.10",
"org.typelevel" %% "cats-effect-laws" % "3.3.10" % 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.3.9",
"org.typelevel" %% "cats-effect" % "3.3.9" % Test)
"org.typelevel" %% "cats-effect-std" % "3.3.10",
"org.typelevel" %% "cats-effect" % "3.3.10" % 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.3.9" % Test
libraryDependencies += "org.typelevel" %% "cats-effect-testkit" % "3.3.10" % 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.
Expand Down
2 changes: 1 addition & 1 deletion docs/core/test-runtime.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.3.9" % Test
libraryDependencies += "org.typelevel" %% "cats-effect-testkit" % "3.3.10" % Test
```

## Example
Expand Down
4 changes: 2 additions & 2 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ title: Getting Started
Add the following to your **build.sbt**:

```scala
libraryDependencies += "org.typelevel" %% "cats-effect" % "3.3.9"
libraryDependencies += "org.typelevel" %% "cats-effect" % "3.3.10"
```

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:
Expand Down Expand Up @@ -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.3.9`
import $ivy.`org.typelevel::cats-effect:3.3.10`

import cats.effect.unsafe.implicits._
import cats.effect.IO
Expand Down
14 changes: 7 additions & 7 deletions docs/migration-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Here is an overview of the steps you should take to migrate your application to
### Before You Begin: This Isn't A "Quick Start" Guide

This guide is meant for existing users of Cats Effect 2 who want to upgrade their applications
to 3.3.9.
to 3.3.10.

> If you haven't used Cats Effect before and want to give it a try,
> please follow the [getting started guide](./getting-started.md) instead!
Expand Down Expand Up @@ -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.3.9",
"org.typelevel" %% "cats-effect-std" % "3.3.9",
"org.typelevel" %% "cats-effect" % "3.3.9",
"org.typelevel" %% "cats-effect-kernel" % "3.3.10",
"org.typelevel" %% "cats-effect-std" % "3.3.10",
"org.typelevel" %% "cats-effect" % "3.3.10",
```

- `kernel` - type class definitions, simple concurrency primitives
Expand All @@ -96,7 +96,7 @@ The current non-test modules are:
libraryDependencies ++= Seq(
//...
- "org.typelevel" %% "cats-effect" % "2.4.0",
+ "org.typelevel" %% "cats-effect" % "3.3.9",
+ "org.typelevel" %% "cats-effect" % "3.3.10",
//...
)
```
Expand All @@ -108,8 +108,8 @@ sbt:demo> update
[error] stack trace is suppressed; run last core / update for the full output
[error] (core / update) found version conflict(s) in library dependencies; some are suspected to be binary incompatible:
[error]
[error] * org.typelevel:cats-effect_2.13:3.3.9 (early-semver) is selected over {2.3.1, 2.1.4}
[error] +- com.example:core-core_2.13:0.0.7-26-3183519d (depends on 3.3.9)
[error] * org.typelevel:cats-effect_2.13:3.3.10 (early-semver) is selected over {2.3.1, 2.1.4}
[error] +- com.example:core-core_2.13:0.0.7-26-3183519d (depends on 3.3.10)
[error] +- io.monix:monix-catnap_2.13:3.3.0 (depends on 2.1.4)
[error] +- com.github.valskalla:odin-core_2.13:0.11.0 (depends on 2.3.1)
[error]
Expand Down
4 changes: 2 additions & 2 deletions docs/tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.3.9"
version := "3.3.10"

scalaVersion := "2.13.6"

libraryDependencies += "org.typelevel" %% "cats-effect" % "3.3.9" withSources() withJavadoc()
libraryDependencies += "org.typelevel" %% "cats-effect" % "3.3.10" withSources() withJavadoc()

scalacOptions ++= Seq(
"-feature",
Expand Down

0 comments on commit 913367b

Please sign in to comment.