Skip to content
This repository was archived by the owner on Jan 13, 2025. It is now read-only.

Commit ad3e235

Browse files
authored
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.
1 parent e950d6b commit ad3e235

File tree

5 files changed

+12
-12
lines changed

5 files changed

+12
-12
lines changed

.github/workflows/ci.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ jobs:
3333
fail-fast: false
3434
matrix:
3535
36-
scala: ['2.11.12', '2.12.15', '2.13.8', '3.1.0']
36+
scala: ['2.11.12', '2.12.15', '2.13.8', '3.2.1']
3737
steps:
3838
- name: Checkout current branch
3939
uses: actions/[email protected]
@@ -46,7 +46,7 @@ jobs:
4646
- name: Cache scala dependencies
4747
uses: coursier/cache-action@v6
4848
- name: Run tests
49-
run: sbt ++${{ matrix.scala }}! test
49+
run: sbt ++${{ matrix.scala }} test
5050

5151
website:
5252
runs-on: ubuntu-20.04

.github/workflows/site.yml

+5-3
Original file line numberDiff line numberDiff line change
@@ -27,12 +27,14 @@ jobs:
2727
distribution: temurin
2828
java-version: 17
2929
check-latest: true
30-
- name: Check that site workflow is up to date
30+
- name: Check if the README file is up to date
31+
run: sbt docs/checkReadme
32+
- name: Check if the site workflow is up to date
3133
run: sbt docs/checkGithubWorkflow
3234
- name: Check artifacts build process
3335
run: sbt +publishLocal
3436
- name: Check website build process
35-
run: sbt docs/buildWebsite
37+
run: sbt docs/clean; sbt docs/buildWebsite
3638
publish-docs:
3739
name: Publish Docs
3840
runs-on: ubuntu-latest
@@ -60,7 +62,7 @@ jobs:
6062
generate-readme:
6163
name: Generate README
6264
runs-on: ubuntu-latest
63-
if: ${{ (github.event_name == 'push') || ((github.event_name == 'release') && (github.event_name == 'published')) }}
65+
if: ${{ (github.event_name == 'push') || ((github.event_name == 'release') && (github.event.action == 'published')) }}
6466
steps:
6567
- name: Git Checkout
6668
uses: actions/[email protected]

build.sbt

+3-3
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,8 @@ lazy val interopReactiveStreams = project
7575
lazy val docs = project
7676
.in(file("zio-interop-reactivestreams-docs"))
7777
.settings(
78-
moduleName := "zio-interop-reactivestreams-docs",
78+
moduleName := "zio-interop-reactivestreams-docs",
79+
crossScalaVersions := Seq(Scala212, Scala213),
7980
scalacOptions -= "-Yno-imports",
8081
scalacOptions -= "-Xfatal-warnings",
8182
libraryDependencies ++= Seq(
@@ -84,8 +85,7 @@ lazy val docs = project
8485
projectName := "ZIO Interop Reactive Streams",
8586
mainModuleName := (interopReactiveStreams / moduleName).value,
8687
projectStage := ProjectStage.ProductionReady,
87-
ScalaUnidoc / unidoc / unidocProjectFilter := inProjects(interopReactiveStreams),
88+
ScalaUnidoc / unidoc / unidocProjectFilter := inProjects(),
8889
docsPublishBranch := "master"
8990
)
90-
.dependsOn(interopReactiveStreams)
9191
.enablePlugins(WebsitePlugin)

project/BuildHelper.scala

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ object BuildHelper {
1111
val Scala211 = "2.11.12"
1212
val Scala212 = "2.12.15"
1313
val Scala213 = "2.13.8"
14-
val ScalaDotty = "3.1.0"
14+
val ScalaDotty = "3.2.1"
1515

1616
private val stdOptions = Seq(
1717
"-deprecation",

project/plugins.sbt

+1-3
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,4 @@ addSbtPlugin("com.github.cb372" % "sbt-explicit-dependencies" % "0.2.16")
66
addSbtPlugin("org.portable-scala" % "sbt-crossproject" % "1.2.0")
77
addSbtPlugin("de.heikoseeberger" % "sbt-header" % "5.9.0")
88
addSbtPlugin("org.scalameta" % "sbt-scalafmt" % "2.5.0")
9-
addSbtPlugin("dev.zio" % "zio-sbt-website" % "0.3.2")
10-
11-
resolvers += Resolver.sonatypeRepo("public")
9+
addSbtPlugin("dev.zio" % "zio-sbt-website" % "0.3.9")

0 commit comments

Comments
 (0)