Merge pull request #442 from danicheg/merge-main-into-series/2.x

Merge main into series/2.x
typelevel · Aug 23, 2023 · 1fd669a · 1fd669a
2 parents a388246 + 9e38477
commit 1fd669a
Show file tree

Hide file tree

Showing 10 changed files with 159 additions and 136 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
diff --git a/DEV.md b/DEV.md
@@ -15,8 +15,16 @@ short or generic names if possible.
 
 However, for new operations, simply providing a lazy by-name variant is often the best choice unless there are clear reasons (eg performance impact) for needing an eager variant.
 
-### Release Process
+## Release Process
 
 Mouse uses Github Actions, https://github.com/djspiewak/sbt-github-actions and https://github.com/typelevel/sbt-typelevel for CI releases. Use the Github Create Release feature to tag a release, and it will publish to Sonatype automatically (using @benhutchison credentials).
 
 sbt-release and sbt-ci-release is no longer in use.
+
+## Choosing an Appropriate Base Branch
+
+There are two options for choosing a base branch for your PRs:
+
+* Use the `main` branch if you would like to deliver changes within the `1.x` series. It's for binary-compatible changes only.
+
+* Use the `series/2.x` branch if you would like to deliver changes within the `2.x` series. It's for non-binary-compatible changes and basically stands for the next major `mouse` release.
diff --git a/docs/contributing-guide.md b/docs/contributing-guide.md
@@ -23,6 +23,14 @@ Mouse uses Github Actions, [sbt-github-actions] and [sbt-typelevel] for CI relea
 Use the Github Create Release feature to tag a release, 
 and it will publish to Sonatype automatically (using @benhutchison credentials).
 
+### Choosing an Appropriate Base Branch
+
+There are two options for choosing a base branch for your PRs:
+
+* Use the `main` branch if you would like to deliver changes within the `1.x` series. It's for binary-compatible changes only.
+
+* Use the `series/2.x` branch if you would like to deliver changes within the `2.x` series. It's for non-binary-compatible changes and basically stands for the next major `mouse` release.
+
 
 [sbt-github-actions]: https://github.com/djspiewak/sbt-github-actions
 [sbt-typelevel]: https://github.com/typelevel/sbt-typelevel

diff --git a/native/src/main/scala-2/mouse/mouse.scala → native/src/main/scala-2/mouse/package.scala b/native/src/main/scala-2/mouse/mouse.scala → native/src/main/scala-2/mouse/package.scala
diff --git a/project/plugins.sbt b/project/plugins.sbt
@@ -2,5 +2,5 @@ addSbtPlugin("org.scala-js" % "sbt-scalajs" % "1.13.2")
 addSbtPlugin("org.portable-scala" % "sbt-scalajs-crossproject" % "1.3.2")
 addSbtPlugin("org.scala-native" % "sbt-scala-native" % "0.4.14")
 addSbtPlugin("org.portable-scala" % "sbt-scala-native-crossproject" % "1.3.2")
-addSbtPlugin("org.typelevel" % "sbt-typelevel" % "0.4.22")
-addSbtPlugin("org.typelevel" % "sbt-typelevel-site" % "0.4.22")
+addSbtPlugin("org.typelevel" % "sbt-typelevel" % "0.5.0")
+addSbtPlugin("org.typelevel" % "sbt-typelevel-site" % "0.5.0")
diff --git a/shared/src/test/scala/mouse/DoubleSyntaxTest.scala b/shared/src/test/scala/mouse/DoubleSyntaxTest.scala
@@ -23,8 +23,9 @@ package mouse
 
 class DoubleSyntaxTest extends MouseSuite {
   test("DoubleSyntax.toByteArray") {
-    assert(
-      123456789.123456789.toByteArray.sameElements(Array(65, -99, 111, 52, 84, 126, 107, 117))
+    assertEquals(
+      123456789.123456789.toByteArray.toSeq,
+      Array[Byte](65, -99, 111, 52, 84, 126, 107, 117).toSeq
     )
   }
 

diff --git a/shared/src/test/scala/mouse/IntSyntaxTest.scala b/shared/src/test/scala/mouse/IntSyntaxTest.scala
@@ -23,7 +23,7 @@ package mouse
 
 class IntSyntaxTest extends MouseSuite {
   test("IntSyntax.toByteArray") {
-    assert(123456789.toByteArray.sameElements(Array(7, 91, -51, 21)))
+    assertEquals(123456789.toByteArray.toSeq, Array[Byte](7, 91, -51, 21).toSeq)
   }
 
   test("IntSyntax.toBase64") {

diff --git a/shared/src/test/scala/mouse/LongSyntaxTest.scala b/shared/src/test/scala/mouse/LongSyntaxTest.scala
@@ -23,8 +23,9 @@ package mouse
 
 class LongSyntaxTest extends MouseSuite {
   test("LongSyntax.toByteArray") {
-    assert(
-      123456789123456789L.toByteArray.sameElements(Array(1, -74, -101, 75, -84, -48, 95, 21))
+    assertEquals(
+      123456789123456789L.toByteArray.toSeq,
+      Array[Byte](1, -74, -101, 75, -84, -48, 95, 21).toSeq
     )
   }
 

diff --git a/shared/src/test/scala/mouse/OptionSyntaxTest.scala b/shared/src/test/scala/mouse/OptionSyntaxTest.scala
@@ -21,12 +21,13 @@
 
 package mouse
 
+import org.typelevel.scalaccompat.annotation._
 import scala.annotation.nowarn
 import scala.util.{Failure, Success}
 
 class OptionSyntaxTest extends MouseSuite {
   implicit class ExtraTest[A](a: A) {
-    def shouldBeA[T](implicit ev: T =:= A): Unit = ()
+    def shouldBeA[T](implicit @nowarn212 ev: T =:= A): Unit = ()
   }
 
   test("OptionSyntax.cata") {

diff --git a/shared/src/test/scala/mouse/TrySyntaxTest.scala b/shared/src/test/scala/mouse/TrySyntaxTest.scala
@@ -23,6 +23,7 @@ package mouse
 
 import cats.syntax.eq._
 
+import org.typelevel.scalaccompat.annotation._
 import org.scalacheck.Gen
 import org.scalacheck.Prop._
 
@@ -73,7 +74,7 @@ class TrySyntaxTest extends MouseSuite {
   }
 
   implicit class ExtraTest[A](a: A) {
-    def shouldBeA[T](implicit ev: T =:= A): Unit = ()
+    def shouldBeA[T](implicit @nowarn212 ev: T =:= A): Unit = ()
   }
 
   property("toEither") {