Merge master to dotty branch

.github/workflows/ci.yml

@@ -9,12 +9,17 @@ name: Continuous Integration
 
 on:
   pull_request:
-    branches: ['*']
+    branches: ['**']
   push:
-    branches: ['*']
+    branches: ['**']
     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 }}
 
 jobs:
@@ -23,20 +28,22 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest]
-        scala: [2.12.15, 2.13.8, 3.1.0]
-        java: [adopt@1.8]
-        ci: [test]
+        scala: [2.12.15, 2.13.8, 3.1.1]
+        java: [temurin@8]
+        project: [rootJS, rootJVM]
     runs-on: ${{ matrix.os }}
     steps:
       - name: Checkout current branch (full)
         uses: actions/checkout@v2
         with:
           fetch-depth: 0
 
-      - name: Setup Java and Scala
-        uses: olafurpg/setup-scala@v10
+      - name: Setup Java (temurin@8)
+        if: matrix.java == 'temurin@8'
+        uses: actions/setup-java@v2
         with:
-          java-version: ${{ matrix.java }}
+          distribution: temurin
+          java-version: 8
 
       - name: Cache sbt
         uses: actions/cache@v2
@@ -51,31 +58,63 @@ jobs:
           key: ${{ runner.os }}-sbt-cache-v2-${{ hashFiles('**/*.sbt') }}-${{ hashFiles('project/build.properties') }}
 
       - name: Check that workflows are up to date
-        run: sbt ++${{ matrix.scala }} githubWorkflowCheck
+        run: sbt 'project ${{ matrix.project }}' '++${{ matrix.scala }}' 'project /' githubWorkflowCheck
 
-      - name: Validation
-        run: sbt ++${{ matrix.scala }} '${{ matrix.ci }}'
+      - name: Check formatting
+        run: sbt 'project ${{ matrix.project }}' '++${{ matrix.scala }}' scalafmtCheckAll scalafmtSbtCheck
+
+      - name: scalaJSLink
+        if: matrix.project == 'rootJS'
+        run: sbt 'project ${{ matrix.project }}' '++${{ matrix.scala }}' Test/scalaJSLinkerResult
+
+      - name: Test
+        run: sbt 'project ${{ matrix.project }}' '++${{ matrix.scala }}' test
+
+      - name: Check binary compatibility
+        if: matrix.java == 'temurin@8'
+        run: sbt 'project ${{ matrix.project }}' '++${{ matrix.scala }}' mimaReportBinaryIssues
+
+      - name: Generate API documentation
+        if: matrix.java == 'temurin@8'
+        run: sbt 'project ${{ matrix.project }}' '++${{ matrix.scala }}' doc
+
+      - name: Make target directories
+        if: github.event_name != 'pull_request' && (startsWith(github.ref, 'refs/tags/v') || github.ref == 'refs/heads/master')
+        run: mkdir -p target .js/target core/.js/target core/.jvm/target .jvm/target .native/target project/target
+
+      - name: Compress target directories
+        if: github.event_name != 'pull_request' && (startsWith(github.ref, 'refs/tags/v') || github.ref == 'refs/heads/master')
+        run: tar cf targets.tar target .js/target core/.js/target core/.jvm/target .jvm/target .native/target project/target
+
+      - name: Upload target directories
+        if: github.event_name != 'pull_request' && (startsWith(github.ref, 'refs/tags/v') || github.ref == 'refs/heads/master')
+        uses: actions/upload-artifact@v2
+        with:
+          name: target-${{ matrix.os }}-${{ matrix.java }}-${{ matrix.scala }}-${{ matrix.project }}
+          path: targets.tar
 
   publish:
     name: Publish Artifacts
     needs: [build]
-    if: github.event_name != 'pull_request' && (startsWith(github.ref, 'refs/tags/v'))
+    if: github.event_name != 'pull_request' && (startsWith(github.ref, 'refs/tags/v') || github.ref == 'refs/heads/master')
     strategy:
       matrix:
         os: [ubuntu-latest]
-        scala: [3.1.0]
-        java: [adopt@1.8]
+        scala: [3.1.1]
+        java: [temurin@8]
     runs-on: ${{ matrix.os }}
     steps:
       - name: Checkout current branch (full)
         uses: actions/checkout@v2
         with:
           fetch-depth: 0
 
-      - name: Setup Java and Scala
-        uses: olafurpg/setup-scala@v10
+      - name: Setup Java (temurin@8)
+        if: matrix.java == 'temurin@8'
+        uses: actions/setup-java@v2
         with:
-          java-version: ${{ matrix.java }}
+          distribution: temurin
+          java-version: 8
 
       - name: Cache sbt
         uses: actions/cache@v2
@@ -89,11 +128,76 @@ jobs:
             ~/Library/Caches/Coursier/v1
           key: ${{ runner.os }}-sbt-cache-v2-${{ hashFiles('**/*.sbt') }}-${{ hashFiles('project/build.properties') }}
 
-      - uses: olafurpg/setup-gpg@v3
+      - name: Download target directories (2.12.15, rootJS)
+        uses: actions/download-artifact@v2
+        with:
+          name: target-${{ matrix.os }}-${{ matrix.java }}-2.12.15-rootJS
+
+      - name: Inflate target directories (2.12.15, rootJS)
+        run: |
+          tar xf targets.tar
+          rm targets.tar
+
+      - name: Download target directories (2.12.15, rootJVM)
+        uses: actions/download-artifact@v2
+        with:
+          name: target-${{ matrix.os }}-${{ matrix.java }}-2.12.15-rootJVM
+
+      - name: Inflate target directories (2.12.15, rootJVM)
+        run: |
+          tar xf targets.tar
+          rm targets.tar
+
+      - name: Download target directories (2.13.8, rootJS)
+        uses: actions/download-artifact@v2
+        with:
+          name: target-${{ matrix.os }}-${{ matrix.java }}-2.13.8-rootJS
+
+      - name: Inflate target directories (2.13.8, rootJS)
+        run: |
+          tar xf targets.tar
+          rm targets.tar
+
+      - name: Download target directories (2.13.8, rootJVM)
+        uses: actions/download-artifact@v2
+        with:
+          name: target-${{ matrix.os }}-${{ matrix.java }}-2.13.8-rootJVM
+
+      - name: Inflate target directories (2.13.8, rootJVM)
+        run: |
+          tar xf targets.tar
+          rm targets.tar
+
+      - name: Download target directories (3.1.1, rootJS)
+        uses: actions/download-artifact@v2
+        with:
+          name: target-${{ matrix.os }}-${{ matrix.java }}-3.1.1-rootJS
+
+      - name: Inflate target directories (3.1.1, rootJS)
+        run: |
+          tar xf targets.tar
+          rm targets.tar
+
+      - name: Download target directories (3.1.1, rootJVM)
+        uses: actions/download-artifact@v2
+        with:
+          name: target-${{ matrix.os }}-${{ matrix.java }}-3.1.1-rootJVM
+
+      - name: Inflate target directories (3.1.1, rootJVM)
+        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
+
+      - name: Import signing key and strip passphrase
+        if: env.PGP_SECRET != '' && env.PGP_PASSPHRASE != ''
+        run: |
+          echo "$PGP_SECRET" | base64 -di > /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)
 
-      - env:
-          PGP_PASSPHRASE: ${{ secrets.PGP_PASSPHRASE }}
-          PGP_SECRET: ${{ secrets.PGP_SECRET }}
-          SONATYPE_PASSWORD: ${{ secrets.SONATYPE_PASSWORD }}
-          SONATYPE_USERNAME: ${{ secrets.SONATYPE_USERNAME }}
-        run: sbt ++${{ matrix.scala }} ci-release
+      - name: Publish
+        run: sbt '++${{ matrix.scala }}' tlRelease

.github/workflows/clean.yml

@@ -56,4 +56,4 @@ jobs:
               printf "Deleting '%s' #%d, %'d bytes\n" $name ${ARTCOUNT[$name]} $size
               ghapi -X DELETE $REPO/actions/artifacts/$id
             done
-          done
+          done

.gitignore

@@ -17,6 +17,13 @@ target/
 *.iml
 *.iws
 
+# Ignore project files for VSCode
+.bloop
+.bsp
+.metals
+.vscode
+metals.sbt
+
 # Ignore OS X metadata
 .DS_Store
 

.scalafmt.conf

@@ -1,5 +1,5 @@
-version = "3.0.0"
-runner.dialect = "scala3"
+version = "3.4.3"
+runner.dialect = scala3
 align.preset = none
 maxColumn = 120
 includeNoParensInSelectChains = false
@@ -10,3 +10,4 @@ rewrite.redundantBraces.stringInterpolation = true
 rewrite.redundantBraces.methodBodies = true
 rewrite.redundantBraces.generalExpressions = true
 rewriteTokens = { "⇒": "=>", "→": "->", "←": "<-" }
+fileOverride { "glob:**/*.sbt" { runner.dialect = scala212 } }

build.sbt

@@ -2,19 +2,17 @@ import sbt._
 
 val scala212 = "2.12.15"
 val scala213 = "2.13.8"
-val scala3 = "3.1.0"
+val scala3 = "3.1.1"
 
 ThisBuild / crossScalaVersions := Seq(scala212, scala213, scala3)
 ThisBuild / scalaVersion := scala3
-
-lazy val buildSettings = Seq(
-  organization := "org.typelevel"
-)
+ThisBuild / tlBaseVersion := "3.0"
+ThisBuild / organization := "org.typelevel"
 
 val catsVersion = "2.7.0"
 val disciplineMunitVersion = "1.0.9"
 val kindProjectorVersion = "0.13.2"
-val shapeless2Version = "2.3.7"
+val shapeless2Version = "2.3.8"
 val shapeless3Version = "3.0.4"
 
 lazy val commonSettings = Seq(
@@ -51,36 +49,19 @@ lazy val commonSettings = Seq(
         compilerPlugin(("org.typelevel" %% "kind-projector" % kindProjectorVersion).cross(CrossVersion.full))
       )
   }),
-  Test / parallelExecution := false,
-  versionScheme := Some("semver-spec"),
-  mimaPreviousArtifacts := Set(organization.value %% moduleName.value % "2.2.1")
+  Test / parallelExecution := false
 )
 
 console / initialCommands := """import shapeless._, cats._, cats.derived._"""
 
-lazy val commonJsSettings = Seq(
-  Global / scalaJSStage := FastOptStage,
-  Test / scalaJSLinkerConfig ~= (_.withModuleKind(ModuleKind.CommonJSModule))
-)
-
-lazy val coreSettings =
-  Seq.concat(buildSettings, commonSettings, crossVersionSharedSources, publishSettings)
-
-lazy val kittens = project
-  .in(file("."))
-  .aggregate(coreJVM)
-  .dependsOn(coreJVM)
-  .settings(coreSettings: _*)
-  .settings(noPublishSettings)
+lazy val root = tlCrossRootProject.aggregate(core)
 
-lazy val core = crossProject(JVMPlatform)
+lazy val core = crossProject(JVMPlatform, JSPlatform)
   .crossType(CrossType.Pure)
   .settings(moduleName := "kittens")
-  .settings(coreSettings: _*)
-
-lazy val coreJVM = core.jvm
+  .settings(commonSettings: _*)
 
-addCommandAlias("root", ";project kittens")
+addCommandAlias("root", ";project /")
 addCommandAlias("jvm", ";project coreJVM")
 addCommandAlias("js", ";project coreJS")
 addCommandAlias("native", ";project coreNative")
@@ -95,43 +76,17 @@ addCommandAlias("mima", "coreJVM/mimaReportBinaryIssues")
 addCommandAlias("fmt", "all scalafmtSbt scalafmtAll")
 addCommandAlias("fmtCheck", "all scalafmtSbtCheck scalafmtCheckAll")
 
-lazy val crossVersionSharedSources: Seq[Setting[_]] = Seq(Compile, Test).map { sc =>
-  (sc / unmanagedSourceDirectories) ++= (sc / unmanagedSourceDirectories).value.map { dir: File =>
-    new File(dir.getPath + "-" + scalaBinaryVersion.value.head)
-  }
-}
-
-lazy val publishSettings = Seq(
-  Test / publishArtifact := false,
-  pomIncludeRepository := (_ => false),
-  homepage := Some(url("https://github.com/typelevel/kittens")),
-  licenses := Seq("Apache 2" -> url("http://www.apache.org/licenses/LICENSE-2.0.txt")),
-  scmInfo := Some(ScmInfo(url("https://github.com/typelevel/kittens"), "scm:git:git@github.com:typelevel/kittens.git")),
-  developers := List(
-    Developer("milessabin", "Miles Sabin", "", url("http://milessabin.com/blog")),
-    Developer("kailuowang", "Kai(luo) Wang", "kailuo.wang@gmail.com", url("http://kailuowang.com/")),
-    Developer("joroKr21", "Georgi Krastev", "joro.kr.21@gmail.com", url("https://twitter.com/Joro_Kr"))
-  )
+ThisBuild / licenses := Seq(License.Apache2)
+ThisBuild / developers := List(
+  Developer("milessabin", "Miles Sabin", "", url("http://milessabin.com/blog")),
+  Developer("kailuowang", "Kai(luo) Wang", "kailuo.wang@gmail.com", url("http://kailuowang.com/")),
+  Developer("joroKr21", "Georgi Krastev", "joro.kr.21@gmail.com", url("https://twitter.com/Joro_Kr"))
 )
 
-lazy val noPublishSettings =
-  publish / skip := true
-
-ThisBuild / githubWorkflowJavaVersions := Seq("adopt@1.8")
-ThisBuild / githubWorkflowArtifactUpload := false
-ThisBuild / githubWorkflowBuildMatrixAdditions += "ci" -> List("test")
-ThisBuild / githubWorkflowBuild := List(WorkflowStep.Sbt(List("${{ matrix.ci }}"), name = Some("Validation")))
-ThisBuild / githubWorkflowTargetTags ++= Seq("v*")
-ThisBuild / githubWorkflowPublishTargetBranches := Seq(RefPredicate.StartsWith(Ref.Tag("v")))
-ThisBuild / githubWorkflowPublishPreamble += WorkflowStep.Use(UseRef.Public("olafurpg", "setup-gpg", "v3"))
-ThisBuild / githubWorkflowPublish := Seq(
+ThisBuild / tlCiReleaseBranches := Seq("master")
+ThisBuild / githubWorkflowBuild ~= { steps =>
   WorkflowStep.Sbt(
-    List("ci-release"),
-    env = Map(
-      "PGP_PASSPHRASE" -> "${{ secrets.PGP_PASSPHRASE }}",
-      "PGP_SECRET" -> "${{ secrets.PGP_SECRET }}",
-      "SONATYPE_PASSWORD" -> "${{ secrets.SONATYPE_PASSWORD }}",
-      "SONATYPE_USERNAME" -> "${{ secrets.SONATYPE_USERNAME }}"
-    )
-  )
-)
+    List("scalafmtCheckAll", "scalafmtSbtCheck"),
+    name = Some("Check formatting")
+  ) +: steps
+}

core/src/main/scala-2.12/cats/derived/semiauto.scala

@@ -1,7 +1,7 @@
 package cats.derived
 
-/** allows semi automatically derive each instance. The derivation might need help when
-  * there are fields with a type constructor that comes with instances, e.g.
+/** allows semi automatically derive each instance. The derivation might need help when there are fields with a type
+  * constructor that comes with instances, e.g.
   * {{{
   * scala> case class Bar(a: String)
   * scala> case class Foo(bars: List[Bar])
@@ -25,9 +25,9 @@ package cats.derived
   *   scala> implicit val fooShow: Show[Foo] = { |
   *             import cats.derived.auto.show._  |
   *             cats.derived.semiauto.show       |
-  *          }
-  *  scala> Foo(List(Bar("a"))).show
-  *  res3: String = Foo(bars = List(Bar(a = a)))
+  *           }
+  *   scala> Foo(List(Bar("a"))).show
+  *   res3: String = Foo(bars = List(Bar(a = a)))
   * }}}
   */
 object semiauto extends SemiAutoInstances