Merge pull request zio#812 from khajavi/unidoc-support

Add Scaladoc Support

.github/workflows/ci.yml

@@ -48,7 +48,7 @@ jobs:
       - name: Cache scala dependencies
         uses: coursier/cache-action@v5
       - name: Run tests
-        run: sbt ++${{ matrix.scala }}! test
+        run: sbt ++${{ matrix.scala }} test
 
   website:
     runs-on: ubuntu-20.04

.github/workflows/site.yml

@@ -3,25 +3,49 @@
 
 name: Website
 'on':
+  workflow_dispatch: {}
   release:
     types:
     - published
   push:
     branches:
     - master
+  pull_request: {}
 jobs:
+  build:
+    name: Build and Test
+    runs-on: ubuntu-latest
+    if: ${{ github.event_name == 'pull_request' }}
+    steps:
+    - name: Git Checkout
+      uses: actions/checkout@v3.3.0
+      with:
+        fetch-depth: '0'
+    - name: Setup Scala
+      uses: actions/setup-java@v3.9.0
+      with:
+        distribution: temurin
+        java-version: 17
+        check-latest: true
+    - 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/clean; sbt  docs/buildWebsite
   publish-docs:
     name: Publish Docs
     runs-on: ubuntu-latest
-    if: ${{ (github.event_name == 'release') && (github.event.action == 'published')
-      }}
+    if: ${{ ((github.event_name == 'release') && (github.event.action == 'published')) || (github.event_name == 'workflow_dispatch') }}
     steps:
     - name: Git Checkout
-      uses: actions/checkout@v3.1.0
+      uses: actions/checkout@v3.3.0
       with:
         fetch-depth: '0'
     - name: Setup Scala
-      uses: actions/setup-java@v3.6.0
+      uses: actions/setup-java@v3.9.0
       with:
         distribution: temurin
         java-version: 17
@@ -32,43 +56,43 @@ jobs:
         node-version: 16.x
         registry-url: https://registry.npmjs.org
     - name: Publish Docs to NPM Registry
-      run: sbt docs/publishToNpm
+      run: sbt  docs/publishToNpm
       env:
         NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
   generate-readme:
     name: Generate README
     runs-on: ubuntu-latest
+    if: ${{ (github.event_name == 'push') || ((github.event_name == 'release') && (github.event_name == 'published')) }}
     steps:
     - name: Git Checkout
-      uses: actions/checkout@v3.1.0
+      uses: actions/checkout@v3.3.0
       with:
         ref: ${{ github.head_ref }}
         fetch-depth: '0'
     - name: Setup Scala
-      uses: actions/setup-java@v3.6.0
+      uses: actions/setup-java@v3.9.0
       with:
         distribution: temurin
         java-version: 17
         check-latest: true
     - name: Generate Readme
-      run: sbt docs/generateReadme
+      run: sbt  docs/generateReadme
     - name: Commit Changes
       run: |
         git config --local user.email "github-actions[bot]@users.noreply.github.com"
         git config --local user.name "github-actions[bot]"
         git add README.md
         git commit -m "Update README.md" || echo "No changes to commit"
     - name: Create Pull Request
-      uses: peter-evans/create-pull-request@v4
+      uses: peter-evans/create-pull-request@v4.2.3
       with:
-        body: |
+        body: |-
           Autogenerated changes after running the `sbt docs/generateReadme` command of the [zio-sbt-website](https://zio.dev/zio-sbt) plugin.
 
           I will automatically update the README.md file whenever there is new change for README.md, e.g.
             - After each release, I will update the version in the installation section.
             - After any changes to the "docs/index.md" file, I will update the README.md file accordingly.
         branch: zio-sbt-website/update-readme
         commit-message: Update README.md
-        branch-suffix: short-commit-hash
+        delete-branch: true
         title: Update README.md
-