Add Scaladoc Support (#354)

* add scaladoc support.

* update site workflow.

* empty scaladoc.

* remove depends on.

* update scala version.

* only scala212 and scala213 for docs module.

* ignore forcing unsupported versions.

* update scala version on ci.

.github/workflows/ci.yml

@@ -33,7 +33,7 @@ jobs:
       fail-fast: false
       matrix:
         java: ['[email protected]', '[email protected]']
-        scala: ['2.11.12', '2.12.15', '2.13.8', '3.1.0']
+        scala: ['2.11.12', '2.12.15', '2.13.8', '3.2.1']
     steps:
       - name: Checkout current branch
         uses: actions/[email protected]
@@ -46,7 +46,7 @@ jobs:
       - name: Cache scala dependencies
         uses: coursier/cache-action@v6
       - name: Run tests
-        run: sbt ++${{ matrix.scala }}! test
+        run: sbt ++${{ matrix.scala }} test
 
   website:
     runs-on: ubuntu-20.04

.github/workflows/site.yml

@@ -27,12 +27,14 @@ jobs:
         distribution: temurin
         java-version: 17
         check-latest: true
-    - name: Check that site workflow is up to date
+    - name: Check if the README file is up to date
+      run: sbt  docs/checkReadme
+    - name: Check if the site workflow is up to date
       run: sbt  docs/checkGithubWorkflow
     - name: Check artifacts build process
       run: sbt  +publishLocal
     - name: Check website build process
-      run: sbt  docs/buildWebsite
+      run: sbt docs/clean; sbt  docs/buildWebsite
   publish-docs:
     name: Publish Docs
     runs-on: ubuntu-latest
@@ -60,7 +62,7 @@ jobs:
   generate-readme:
     name: Generate README
     runs-on: ubuntu-latest
-    if: ${{ (github.event_name == 'push') || ((github.event_name == 'release') && (github.event_name == 'published')) }}
+    if: ${{ (github.event_name == 'push') || ((github.event_name == 'release') && (github.event.action == 'published')) }}
     steps:
     - name: Git Checkout
       uses: actions/[email protected]

build.sbt

@@ -75,7 +75,8 @@ lazy val interopReactiveStreams = project
 lazy val docs = project
   .in(file("zio-interop-reactivestreams-docs"))
   .settings(
-    moduleName := "zio-interop-reactivestreams-docs",
+    moduleName         := "zio-interop-reactivestreams-docs",
+    crossScalaVersions := Seq(Scala212, Scala213),
     scalacOptions -= "-Yno-imports",
     scalacOptions -= "-Xfatal-warnings",
     libraryDependencies ++= Seq(
@@ -84,8 +85,7 @@ lazy val docs = project
     projectName                                := "ZIO Interop Reactive Streams",
     mainModuleName                             := (interopReactiveStreams / moduleName).value,
     projectStage                               := ProjectStage.ProductionReady,
-    ScalaUnidoc / unidoc / unidocProjectFilter := inProjects(interopReactiveStreams),
+    ScalaUnidoc / unidoc / unidocProjectFilter := inProjects(),
     docsPublishBranch                          := "master"
   )
-  .dependsOn(interopReactiveStreams)
   .enablePlugins(WebsitePlugin)

project/BuildHelper.scala

@@ -11,7 +11,7 @@ object BuildHelper {
   val Scala211   = "2.11.12"
   val Scala212   = "2.12.15"
   val Scala213   = "2.13.8"
-  val ScalaDotty = "3.1.0"
+  val ScalaDotty = "3.2.1"
 
   private val stdOptions = Seq(
     "-deprecation",

project/plugins.sbt

@@ -6,6 +6,4 @@ addSbtPlugin("com.github.cb372"   % "sbt-explicit-dependencies" % "0.2.16")
 addSbtPlugin("org.portable-scala" % "sbt-crossproject"          % "1.2.0")
 addSbtPlugin("de.heikoseeberger"  % "sbt-header"                % "5.9.0")
 addSbtPlugin("org.scalameta"      % "sbt-scalafmt"              % "2.5.0")
-addSbtPlugin("dev.zio"            % "zio-sbt-website"           % "0.3.2")
-
-resolvers += Resolver.sonatypeRepo("public")
+addSbtPlugin("dev.zio"            % "zio-sbt-website"           % "0.3.9")