diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index dea1f4d4..e673aa50 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -15,56 +15,42 @@ on: tags: [v*] env: - PGP_PASSPHRASE: ${{ secrets.PGP_PASSPHRASE }} - SONATYPE_PASSWORD: ${{ secrets.SONATYPE_PASSWORD }} - SONATYPE_CREDENTIAL_HOST: ${{ secrets.SONATYPE_CREDENTIAL_HOST }} - SONATYPE_USERNAME: ${{ secrets.SONATYPE_USERNAME }} - PGP_SECRET: ${{ secrets.PGP_SECRET }} GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + +concurrency: + group: ${{ github.workflow }} @ ${{ github.ref }} + cancel-in-progress: true + jobs: build: name: Build and Test strategy: matrix: os: [ubuntu-latest] - scala: [2.13.12, 2.12.19, 3.4.1] + scala: [2.13, 2.12, 3] java: [temurin@8] - project: [rootJS, rootJVM, rootNative] + project: [cats-stmNative, cats-stmJVM, cats-stmJS] runs-on: ${{ matrix.os }} + timeout-minutes: 60 steps: - name: Checkout current branch (full) - uses: actions/checkout@v3 + uses: actions/checkout@v4 with: fetch-depth: 0 - - name: Download Java (temurin@8) - id: download-java-temurin-8 - if: matrix.java == 'temurin@8' - uses: typelevel/download-java@v2 - with: - distribution: temurin - java-version: 8 - - name: Setup Java (temurin@8) + id: setup-java-temurin-8 if: matrix.java == 'temurin@8' - uses: actions/setup-java@v3 + uses: actions/setup-java@v4 with: - distribution: jdkfile + distribution: temurin java-version: 8 - jdkFile: ${{ steps.download-java-temurin-8.outputs.jdkFile }} + cache: sbt - - name: Cache sbt - uses: actions/cache@v3 - with: - path: | - ~/.sbt - ~/.ivy2/cache - ~/.coursier/cache/v1 - ~/.cache/coursier/v1 - ~/AppData/Local/Coursier/Cache/v1 - ~/Library/Caches/Coursier/v1 - key: ${{ runner.os }}-sbt-cache-v2-${{ hashFiles('**/*.sbt') }}-${{ hashFiles('project/build.properties') }} + - name: sbt update + if: matrix.java == 'temurin@8' && steps.setup-java-temurin-8.outputs.cache-hit == 'false' + run: sbt +update - name: Check that workflows are up to date run: sbt githubWorkflowCheck @@ -73,14 +59,14 @@ jobs: if: matrix.java == 'temurin@8' && matrix.os == 'ubuntu-latest' run: sbt 'project ${{ matrix.project }}' '++ ${{ matrix.scala }}' headerCheckAll scalafmtCheckAll 'project /' scalafmtSbtCheck - - name: scalaJSLink - if: matrix.project == 'rootJS' - run: sbt 'project ${{ matrix.project }}' '++ ${{ matrix.scala }}' Test/scalaJSLinkerResult - - name: nativeLink - if: matrix.project == 'rootNative' + if: matrix.project == 'cats-stmNative' run: sbt 'project ${{ matrix.project }}' '++ ${{ matrix.scala }}' Test/nativeLink + - name: scalaJSLink + if: matrix.project == 'cats-stmJS' + run: sbt 'project ${{ matrix.project }}' '++ ${{ matrix.scala }}' Test/scalaJSLinkerResult + - name: Test run: sbt 'project ${{ matrix.project }}' '++ ${{ matrix.scala }}' test @@ -94,15 +80,15 @@ jobs: - name: Make target directories if: github.event_name != 'pull_request' && (startsWith(github.ref, 'refs/tags/v') || github.ref == 'refs/heads/main') - run: mkdir -p benchmarks/target target unidoc/target .js/target core/native/target site/target laws/target core/js/target examples/js/target core/jvm/target .jvm/target .native/target examples/jvm/target project/target + run: mkdir -p unidoc/target core/native/target core/js/target core/jvm/target project/target - name: Compress target directories if: github.event_name != 'pull_request' && (startsWith(github.ref, 'refs/tags/v') || github.ref == 'refs/heads/main') - run: tar cf targets.tar benchmarks/target target unidoc/target .js/target core/native/target site/target laws/target core/js/target examples/js/target core/jvm/target .jvm/target .native/target examples/jvm/target project/target + run: tar cf targets.tar unidoc/target core/native/target core/js/target core/jvm/target project/target - name: Upload target directories if: github.event_name != 'pull_request' && (startsWith(github.ref, 'refs/tags/v') || github.ref == 'refs/heads/main') - uses: actions/upload-artifact@v3 + uses: actions/upload-artifact@v4 with: name: target-${{ matrix.os }}-${{ matrix.java }}-${{ matrix.scala }}-${{ matrix.project }} path: targets.tar @@ -118,144 +104,140 @@ jobs: runs-on: ${{ matrix.os }} steps: - name: Checkout current branch (full) - uses: actions/checkout@v3 + uses: actions/checkout@v4 with: fetch-depth: 0 - - name: Download Java (temurin@8) - id: download-java-temurin-8 + - name: Setup Java (temurin@8) + id: setup-java-temurin-8 if: matrix.java == 'temurin@8' - uses: typelevel/download-java@v2 + uses: actions/setup-java@v4 with: distribution: temurin java-version: 8 + cache: sbt - - name: Setup Java (temurin@8) - if: matrix.java == 'temurin@8' - uses: actions/setup-java@v3 - with: - distribution: jdkfile - java-version: 8 - jdkFile: ${{ steps.download-java-temurin-8.outputs.jdkFile }} + - name: sbt update + if: matrix.java == 'temurin@8' && steps.setup-java-temurin-8.outputs.cache-hit == 'false' + run: sbt +update - - name: Cache sbt - uses: actions/cache@v3 - with: - path: | - ~/.sbt - ~/.ivy2/cache - ~/.coursier/cache/v1 - ~/.cache/coursier/v1 - ~/AppData/Local/Coursier/Cache/v1 - ~/Library/Caches/Coursier/v1 - key: ${{ runner.os }}-sbt-cache-v2-${{ hashFiles('**/*.sbt') }}-${{ hashFiles('project/build.properties') }} - - - name: Download target directories (2.13.12, rootJS) - uses: actions/download-artifact@v3 + - name: Download target directories (2.13, cats-stmNative) + uses: actions/download-artifact@v4 with: - name: target-${{ matrix.os }}-${{ matrix.java }}-2.13.12-rootJS + name: target-${{ matrix.os }}-${{ matrix.java }}-2.13-cats-stmNative - - name: Inflate target directories (2.13.12, rootJS) + - name: Inflate target directories (2.13, cats-stmNative) run: | tar xf targets.tar rm targets.tar - - name: Download target directories (2.13.12, rootJVM) - uses: actions/download-artifact@v3 + - name: Download target directories (2.13, cats-stmJVM) + uses: actions/download-artifact@v4 with: - name: target-${{ matrix.os }}-${{ matrix.java }}-2.13.12-rootJVM + name: target-${{ matrix.os }}-${{ matrix.java }}-2.13-cats-stmJVM - - name: Inflate target directories (2.13.12, rootJVM) + - name: Inflate target directories (2.13, cats-stmJVM) run: | tar xf targets.tar rm targets.tar - - name: Download target directories (2.13.12, rootNative) - uses: actions/download-artifact@v3 + - name: Download target directories (2.13, cats-stmJS) + uses: actions/download-artifact@v4 with: - name: target-${{ matrix.os }}-${{ matrix.java }}-2.13.12-rootNative + name: target-${{ matrix.os }}-${{ matrix.java }}-2.13-cats-stmJS - - name: Inflate target directories (2.13.12, rootNative) + - name: Inflate target directories (2.13, cats-stmJS) run: | tar xf targets.tar rm targets.tar - - name: Download target directories (2.12.19, rootJS) - uses: actions/download-artifact@v3 + - name: Download target directories (2.12, cats-stmNative) + uses: actions/download-artifact@v4 with: - name: target-${{ matrix.os }}-${{ matrix.java }}-2.12.19-rootJS + name: target-${{ matrix.os }}-${{ matrix.java }}-2.12-cats-stmNative - - name: Inflate target directories (2.12.19, rootJS) + - name: Inflate target directories (2.12, cats-stmNative) run: | tar xf targets.tar rm targets.tar - - name: Download target directories (2.12.19, rootJVM) - uses: actions/download-artifact@v3 + - name: Download target directories (2.12, cats-stmJVM) + uses: actions/download-artifact@v4 with: - name: target-${{ matrix.os }}-${{ matrix.java }}-2.12.19-rootJVM + name: target-${{ matrix.os }}-${{ matrix.java }}-2.12-cats-stmJVM - - name: Inflate target directories (2.12.19, rootJVM) + - name: Inflate target directories (2.12, cats-stmJVM) run: | tar xf targets.tar rm targets.tar - - name: Download target directories (2.12.19, rootNative) - uses: actions/download-artifact@v3 + - name: Download target directories (2.12, cats-stmJS) + uses: actions/download-artifact@v4 with: - name: target-${{ matrix.os }}-${{ matrix.java }}-2.12.19-rootNative + name: target-${{ matrix.os }}-${{ matrix.java }}-2.12-cats-stmJS - - name: Inflate target directories (2.12.19, rootNative) + - name: Inflate target directories (2.12, cats-stmJS) run: | tar xf targets.tar rm targets.tar - - name: Download target directories (3.4.1, rootJS) - uses: actions/download-artifact@v3 + - name: Download target directories (3, cats-stmNative) + uses: actions/download-artifact@v4 with: - name: target-${{ matrix.os }}-${{ matrix.java }}-3.4.1-rootJS + name: target-${{ matrix.os }}-${{ matrix.java }}-3-cats-stmNative - - name: Inflate target directories (3.4.1, rootJS) + - name: Inflate target directories (3, cats-stmNative) run: | tar xf targets.tar rm targets.tar - - name: Download target directories (3.4.1, rootJVM) - uses: actions/download-artifact@v3 + - name: Download target directories (3, cats-stmJVM) + uses: actions/download-artifact@v4 with: - name: target-${{ matrix.os }}-${{ matrix.java }}-3.4.1-rootJVM + name: target-${{ matrix.os }}-${{ matrix.java }}-3-cats-stmJVM - - name: Inflate target directories (3.4.1, rootJVM) + - name: Inflate target directories (3, cats-stmJVM) run: | tar xf targets.tar rm targets.tar - - name: Download target directories (3.4.1, rootNative) - uses: actions/download-artifact@v3 + - name: Download target directories (3, cats-stmJS) + uses: actions/download-artifact@v4 with: - name: target-${{ matrix.os }}-${{ matrix.java }}-3.4.1-rootNative + name: target-${{ matrix.os }}-${{ matrix.java }}-3-cats-stmJS - - name: Inflate target directories (3.4.1, rootNative) + - name: Inflate target directories (3, cats-stmJS) run: | tar xf targets.tar rm targets.tar - name: Import signing key if: env.PGP_SECRET != '' && env.PGP_PASSPHRASE == '' - run: echo $PGP_SECRET | base64 -di | gpg --import + env: + PGP_SECRET: ${{ secrets.PGP_SECRET }} + PGP_PASSPHRASE: ${{ secrets.PGP_PASSPHRASE }} + run: echo $PGP_SECRET | base64 -d -i - | gpg --import - name: Import signing key and strip passphrase if: env.PGP_SECRET != '' && env.PGP_PASSPHRASE != '' + env: + PGP_SECRET: ${{ secrets.PGP_SECRET }} + PGP_PASSPHRASE: ${{ secrets.PGP_PASSPHRASE }} run: | - echo "$PGP_SECRET" | base64 -di > /tmp/signing-key.gpg + echo "$PGP_SECRET" | base64 -d -i - > /tmp/signing-key.gpg echo "$PGP_PASSPHRASE" | gpg --pinentry-mode loopback --passphrase-fd 0 --import /tmp/signing-key.gpg (echo "$PGP_PASSPHRASE"; echo; echo) | gpg --command-fd 0 --pinentry-mode loopback --change-passphrase $(gpg --list-secret-keys --with-colons 2> /dev/null | grep '^sec:' | cut --delimiter ':' --fields 5 | tail -n 1) - name: Publish + env: + SONATYPE_USERNAME: ${{ secrets.SONATYPE_USERNAME }} + SONATYPE_PASSWORD: ${{ secrets.SONATYPE_PASSWORD }} + SONATYPE_CREDENTIAL_HOST: ${{ secrets.SONATYPE_CREDENTIAL_HOST }} run: sbt tlCiRelease - site: - name: Generate Site + dependency-submission: + name: Submit Dependencies + if: github.event_name != 'pull_request' strategy: matrix: os: [ubuntu-latest] @@ -263,44 +245,74 @@ jobs: runs-on: ${{ matrix.os }} steps: - name: Checkout current branch (full) - uses: actions/checkout@v3 + uses: actions/checkout@v4 with: fetch-depth: 0 - - name: Download Java (temurin@8) - id: download-java-temurin-8 + - name: Setup Java (temurin@8) + id: setup-java-temurin-8 if: matrix.java == 'temurin@8' - uses: typelevel/download-java@v2 + uses: actions/setup-java@v4 with: distribution: temurin java-version: 8 + cache: sbt + + - name: sbt update + if: matrix.java == 'temurin@8' && steps.setup-java-temurin-8.outputs.cache-hit == 'false' + run: sbt +update + + - name: Submit Dependencies + uses: scalacenter/sbt-dependency-submission@v2 + with: + modules-ignore: benchmarks_2.13 benchmarks_2.12 benchmarks_3 docs_2.13 docs_2.12 docs_3 laws_2.13 laws_2.12 laws_3 examples_sjs1_2.13 examples_sjs1_2.12 examples_sjs1_3 cats-stmnative_2.13 cats-stmnative_2.12 cats-stmnative_3 cats-stmjvm_2.13 cats-stmjvm_2.12 cats-stmjvm_3 examples_2.13 examples_2.12 examples_3 cats-stmjs_2.13 cats-stmjs_2.12 cats-stmjs_3 + configs-ignore: test scala-tool scala-doc-tool test-internal + + site: + name: Generate Site + strategy: + matrix: + os: [ubuntu-latest] + java: [temurin@11] + runs-on: ${{ matrix.os }} + steps: + - name: Checkout current branch (full) + uses: actions/checkout@v4 + with: + fetch-depth: 0 - name: Setup Java (temurin@8) + id: setup-java-temurin-8 if: matrix.java == 'temurin@8' - uses: actions/setup-java@v3 + uses: actions/setup-java@v4 with: - distribution: jdkfile + distribution: temurin java-version: 8 - jdkFile: ${{ steps.download-java-temurin-8.outputs.jdkFile }} + cache: sbt + + - name: sbt update + if: matrix.java == 'temurin@8' && steps.setup-java-temurin-8.outputs.cache-hit == 'false' + run: sbt +update - - name: Cache sbt - uses: actions/cache@v3 + - name: Setup Java (temurin@11) + id: setup-java-temurin-11 + if: matrix.java == 'temurin@11' + uses: actions/setup-java@v4 with: - path: | - ~/.sbt - ~/.ivy2/cache - ~/.coursier/cache/v1 - ~/.cache/coursier/v1 - ~/AppData/Local/Coursier/Cache/v1 - ~/Library/Caches/Coursier/v1 - key: ${{ runner.os }}-sbt-cache-v2-${{ hashFiles('**/*.sbt') }}-${{ hashFiles('project/build.properties') }} + distribution: temurin + java-version: 11 + cache: sbt + + - name: sbt update + if: matrix.java == 'temurin@11' && steps.setup-java-temurin-11.outputs.cache-hit == 'false' + run: sbt +update - name: Generate site run: sbt docs/tlSite - name: Publish site if: github.event_name != 'pull_request' && github.ref == 'refs/heads/main' - uses: peaceiris/actions-gh-pages@v3.9.0 + uses: peaceiris/actions-gh-pages@v3.9.3 with: github_token: ${{ secrets.GITHUB_TOKEN }} publish_dir: site/target/docs/site diff --git a/benchmarks/src/main/scala/io/github/timwspence/cats/stm/TxnBenchmarks.scala b/benchmarks/src/main/scala/io/github/timwspence/cats/stm/TxnBenchmarks.scala index 99ef40fb..e6da1013 100644 --- a/benchmarks/src/main/scala/io/github/timwspence/cats/stm/TxnBenchmarks.scala +++ b/benchmarks/src/main/scala/io/github/timwspence/cats/stm/TxnBenchmarks.scala @@ -21,6 +21,7 @@ import java.util.concurrent.TimeUnit import cats.effect.IO import cats.effect.unsafe.implicits.global import org.openjdk.jmh.annotations._ +import org.typelevel.scalaccompat.annotation._ /** * To do comparative benchmarks between versions: @@ -45,6 +46,7 @@ class TxnBenchmark { val stm = STM.runtime[IO].unsafeRunSync() import stm._ + @nowarn3 @Param(Array("1000")) var size: Int = _ diff --git a/build.sbt b/build.sbt index 86e1b084..ecb1706c 100644 --- a/build.sbt +++ b/build.sbt @@ -11,7 +11,7 @@ ThisBuild / startYear := Some(2017) ThisBuild / tlSonatypeUseLegacyHost := false -val Scala213 = "2.13.12" +val Scala213 = "2.13.13" ThisBuild / crossScalaVersions := Seq(Scala213, "2.12.19", "3.4.1") ThisBuild / scalaVersion := Scala213 // the default Scala ThisBuild / tlJdkRelease := Some(8) @@ -85,10 +85,7 @@ lazy val docs = project .in(file("site")) .settings( laikaConfig ~= { _.withRawContent }, - tlSiteRelatedProjects := Seq( - TypelevelProject.Cats, - TypelevelProject.CatsEffect - ) + tlSiteIsTypelevelProject := Some(TypelevelProject.Affiliate) ) .enablePlugins(TypelevelSitePlugin) //TODO cross-build this diff --git a/core/shared/src/main/scala/io/github/timwspence/cats/stm/STMLike.scala b/core/shared/src/main/scala/io/github/timwspence/cats/stm/STMLike.scala index 8f93eed0..ee077542 100644 --- a/core/shared/src/main/scala/io/github/timwspence/cats/stm/STMLike.scala +++ b/core/shared/src/main/scala/io/github/timwspence/cats/stm/STMLike.scala @@ -25,6 +25,7 @@ import cats.effect.std.Semaphore import cats.effect.{Async, Concurrent, Deferred, Ref, Resource} import cats.implicits._ import cats.{Defer, MonadError, Monoid, MonoidK, StackSafeMonad} +import org.typelevel.scalaccompat.annotation._ import STMConstants._ @@ -94,7 +95,7 @@ trait STMLike[F[_]] { * Non matching errors and successful values are not affected by this function. */ final def adaptError(pf: PartialFunction[Throwable, Throwable]): Txn[A] = - recoverWith(pf.andThen(raiseError[A] _)) + recoverWith(pf.andThen(raiseError[A](_))) /* * Replaces the `A` value in `F[A]` with the supplied value. @@ -301,6 +302,7 @@ trait STMLike[F[_]] { private[stm] def defer[A](value: => Txn[A]): Txn[A] = pure(()).flatMap(_ => value) + @nowarn3 implicit val monadForTxn: StackSafeMonad[Txn] with MonadError[Txn, Throwable] with MonoidK[Txn] = new StackSafeMonad[Txn] with MonadError[Txn, Throwable] with MonoidK[Txn] { diff --git a/laws/src/test/scala/io/github/timwspence/cats/stm/STMLaws.scala b/laws/src/test/scala/io/github/timwspence/cats/stm/STMLaws.scala index aa056a05..f8c8a0d2 100644 --- a/laws/src/test/scala/io/github/timwspence/cats/stm/STMLaws.scala +++ b/laws/src/test/scala/io/github/timwspence/cats/stm/STMLaws.scala @@ -42,13 +42,13 @@ trait STMLaws extends HasSTM { (tvar.set(a) >> stm.abort[A](error)) <-> stm.abort[A](error) def retryOrElse[A](txn: Txn[A]) = - (stm.retry[A] orElse txn) <-> txn + (stm.retry[A].orElse(txn)) <-> txn def orElseRetry[A](txn: Txn[A]) = - (txn orElse stm.retry[A]) <-> txn + (txn.orElse(stm.retry[A])) <-> txn def abortOrElse[A](error: Throwable, txn: Txn[A]) = - (stm.abort[A](error) orElse txn) <-> stm.abort[A](error) + (stm.abort[A](error).orElse(txn)) <-> stm.abort[A](error) } @@ -66,14 +66,14 @@ trait STMTests extends Laws with STMLaws { new DefaultRuleSet( name = "stm", parent = None, - "get then get is get" -> forAll(getThenGet[A] _), - "set then get is set then pure" -> forAll(setThenGet[A] _), - "set then set is set" -> forAll(setThenSet[A] _), - "set then retry is retry" -> forAll(setThenRetry[A] _), - "set then abort is abort" -> forAll(setThenAbort[A] _), - "retry orElse stm is stm" -> forAll(retryOrElse[A] _), - "stm orElse retry is stm" -> forAll(orElseRetry[A] _), - "abort orElse stm is abort" -> forAll(abortOrElse[A] _) + "get then get is get" -> forAll(getThenGet[A](_)), + "set then get is set then pure" -> forAll(setThenGet[A](_, _)), + "set then set is set" -> forAll(setThenSet[A](_, _, _)), + "set then retry is retry" -> forAll(setThenRetry[A](_, _)), + "set then abort is abort" -> forAll(setThenAbort[A](_, _, _)), + "retry orElse stm is stm" -> forAll(retryOrElse[A](_)), + "stm orElse retry is stm" -> forAll(orElseRetry[A](_)), + "abort orElse stm is abort" -> forAll(abortOrElse[A](_, _)) ) } diff --git a/project/plugins.sbt b/project/plugins.sbt index 759af470..efd7043f 100644 --- a/project/plugins.sbt +++ b/project/plugins.sbt @@ -1,6 +1,6 @@ addSbtPlugin("pl.project13.scala" % "sbt-jmh" % "0.4.7") -addSbtPlugin("org.typelevel" % "sbt-typelevel" % "0.4.22") -addSbtPlugin("org.typelevel" % "sbt-typelevel-site" % "0.4.22") +addSbtPlugin("org.typelevel" % "sbt-typelevel" % "0.7.0") +addSbtPlugin("org.typelevel" % "sbt-typelevel-site" % "0.7.0") addSbtPlugin("org.scala-js" % "sbt-scalajs" % "1.16.0") addSbtPlugin("org.scala-native" % "sbt-scala-native" % "0.4.17") addSbtPlugin("org.portable-scala" % "sbt-scala-native-crossproject" % "1.3.2")