Publish Docs to NPM registry (#155)

* prepare docs.

* install zio-sbt-website plugin.

* update readme.

* remove website.

* update ci.

* update homepage url.

Co-authored-by: Milad Khajavi <khajavi@gmail.com>

.github/workflows/ci.yml

@@ -112,7 +112,7 @@ jobs:
       - name: Cache scala dependencies
         uses: coursier/cache-action@v6
       - name: Check Website Generation
-        run: ./sbt docs/docusaurusCreateSite
+        run: ./sbt docs/compileDocs
 
   ci:
     runs-on: ubuntu-20.04

.github/workflows/site.yml

@@ -1,34 +1,28 @@
-name: Website
+# This file was autogenerated using `zio-sbt` via `sbt generateGithubWorkflow`
+# task and should be included in the git repository. Please do not edit
+# it manually.
+
+name: website
 
 on:
-  push:
-    branches:
-      - master
   release:
-    types:
-      - published
+    types: [ published ]
 
 jobs:
--  publish:
+  publish-docs:
     runs-on: ubuntu-20.04
     timeout-minutes: 30
     steps:
-      - name: Checkout current branch
-        uses: actions/checkout@v3
-      - name: Setup Java
-        uses: actions/setup-java@v3.8.0
+      - uses: actions/checkout@v3.1.0
         with:
-          distribution: temurin
-          java-version: 17
-          check-latest: true
-      - name: Install libuv
-        run: sudo apt-get update && sudo apt-get install -y libuv1-dev
-      - name: Set Swap Space
-        uses: pierotofy/set-swap-space@master
+          fetch-depth: 0
+      - name: Setup Scala and Java
+        uses: olafurpg/setup-scala@v13
+      - uses: actions/setup-node@v3
         with:
-          swap-size-gb: 7
-      - run: sbt docs/docusaurusPublishGhpages
-      - name: Publish the site
-        run: ./sbt docs/docusaurusPublishGhpages
+          node-version: '16.x'
+          registry-url: 'https://registry.npmjs.org'
+      - name: Publishing Docs to NPM Registry
+        run: sbt docs/publishToNpm
         env:
-          GIT_DEPLOY_KEY: ${{ secrets.GIT_DEPLOY_KEY }}
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

README.md

@@ -41,14 +41,14 @@ And visualize your application performance in a number of different ways:
 ![Tracing Profiler Output](./website/static/img/example_tracing_profile.svg?raw=true")
 
 # Documentation
-[zio-profiling Microsite](https://zio.github.io/zio-profiling/)
+[ZIO Profiling Microsite](https://zio.dev/zio-profiling/)
 
 # Contributing
-[Documentation for contributors](https://zio.github.io/zio-profiling/docs/about/about_contributing)
+[Documentation for contributors](https://zio.dev/about/contributing/)
 
 ## Code of Conduct
 
-See the [Code of Conduct](https://zio.github.io/zio-profiling/docs/about/about_coc)
+See the [Code of Conduct](https://zio.dev/about/code-of-conduct)
 
 ## Support
 

build.sbt

@@ -6,7 +6,7 @@ import Dependencies._
 inThisBuild(
   List(
     organization := "dev.zio",
-    homepage     := Some(url("https://zio.github.io/zio-profiling/")),
+    homepage     := Some(url("https://zio.dev/zio-profiling/")),
     licenses     := List("Apache-2.0" -> url("http://www.apache.org/licenses/LICENSE-2.0")),
     developers := List(
       Developer("jdegoes", "John De Goes", "john@degoes.net", url("http://degoes.net")),
@@ -27,10 +27,8 @@ addCommandAlias("prepare", "fix; fmt")
 
 lazy val root = project
   .in(file("."))
-  .settings(
-    publish / skip := true
-  )
-  .aggregate(core, taggingPlugin, examples, benchmarks, docs)
+  .settings(publish / skip := true)
+  .aggregate(core, taggingPlugin, examples, benchmarks)
 
 lazy val core = project
   .in(file("zio-profiling"))
@@ -76,16 +74,10 @@ lazy val benchmarks = project
 lazy val docs = project
   .in(file("zio-profiling-docs"))
   .dependsOn(core)
-  .enablePlugins(MdocPlugin, DocusaurusPlugin, ScalaUnidocPlugin)
+  .enablePlugins(WebsitePlugin)
   .settings(
     publish / skip := true,
     moduleName     := "zio-profiling-docs",
     scalacOptions -= "-Yno-imports",
-    scalacOptions -= "-Xfatal-warnings",
-    mdocIn                                     := (LocalRootProject / baseDirectory).value / "docs",
-    ScalaUnidoc / unidoc / unidocProjectFilter := inProjects(core),
-    ScalaUnidoc / unidoc / target              := (LocalRootProject / baseDirectory).value / "website" / "static" / "api",
-    cleanFiles += (ScalaUnidoc / unidoc / target).value,
-    docusaurusCreateSite     := docusaurusCreateSite.dependsOn(Compile / unidoc).value,
-    docusaurusPublishGhpages := docusaurusPublishGhpages.dependsOn(Compile / unidoc).value
+    scalacOptions -= "-Xfatal-warnings"
   )