Update zio-sbt-website Plugin

.github/workflows/ci.yml

@@ -184,6 +184,68 @@ jobs:
       - name: Test on different Scala target platforms
         run: ./sbt root${{ matrix.platform }}/test
 
+  update-readme:
+    name: Update README
+    runs-on: ubuntu-latest
+    continue-on-error: false
+    if: ${{ github.event_name == 'push' }}
+    steps:
+      - name: Git Checkout
+        uses: actions/[email protected]
+        with:
+          fetch-depth: '0'
+      - name: Install libuv
+        run: sudo apt-get update && sudo apt-get install -y libuv1-dev
+      - name: Setup Scala
+        uses: actions/[email protected]
+        with:
+          distribution: temurin
+          java-version: '8'
+          check-latest: true
+      - name: Cache Dependencies
+        uses: coursier/cache-action@v6
+      - name: Generate Readme
+        run: sbt docs/generateReadme
+      - name: Commit Changes
+        run: |
+          git config --local user.email "zio-assistant[bot]@users.noreply.github.com"
+          git config --local user.name "ZIO Assistant"
+          git add README.md
+          git commit -m "Update README.md" || echo "No changes to commit"
+      - name: Generate Token
+        id: generate-token
+        uses: zio/[email protected]
+        with:
+          app_id: ${{ secrets.APP_ID }}
+          app_private_key: ${{ secrets.APP_PRIVATE_KEY }}
+      - name: Create Pull Request
+        id: cpr
+        uses: peter-evans/[email protected]
+        with:
+          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
+          token: ${{ steps.generate-token.outputs.token }}
+          delete-branch: true
+          title: Update README.md
+      - name: Approve PR
+        if: ${{ steps.cpr.outputs.pull-request-number }}
+        run: gh pr review "$PR_URL" --approve
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          PR_URL: ${{ steps.cpr.outputs.pull-request-url }}
+      - name: Enable Auto-Merge
+        if: ${{ steps.cpr.outputs.pull-request-number }}
+        run: gh pr merge --auto --squash "$PR_URL" || gh pr merge --squash "$PR_URL"
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          PR_URL: ${{ steps.cpr.outputs.pull-request-url }}
+
   ci:
     runs-on: ubuntu-22.04
     needs: [lint, compile, publishLocal, test, testJvms, testPlatforms]
@@ -222,3 +284,64 @@ jobs:
           PGP_SECRET: ${{ secrets.PGP_SECRET }}
           SONATYPE_PASSWORD: ${{ secrets.SONATYPE_PASSWORD }}
           SONATYPE_USERNAME: ${{ secrets.SONATYPE_USERNAME }}
+
+  release-docs:
+    name: Release Docs
+    runs-on: ubuntu-latest
+    continue-on-error: false
+    needs:
+      - publish
+    if: ${{ ((github.event_name == 'release') && (github.event.action == 'published')) || (github.event_name == 'workflow_dispatch') }}
+    steps:
+      - name: Git Checkout
+        uses: actions/[email protected]
+        with:
+          fetch-depth: '0'
+      - name: Install libuv
+        run: sudo apt-get update && sudo apt-get install -y libuv1-dev
+      - name: Setup Scala
+        uses: actions/[email protected]
+        with:
+          distribution: temurin
+          java-version: '8'
+          check-latest: true
+      - name: Cache Dependencies
+        uses: coursier/cache-action@v6
+      - name: Setup NodeJs
+        uses: actions/setup-node@v3
+        with:
+          node-version: 16.x
+          registry-url: https://registry.npmjs.org
+      - name: Publish Docs to NPM Registry
+        run: sbt docs/publishToNpm
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+
+  notify-docs-release:
+    name: Notify Docs Release
+    runs-on: ubuntu-latest
+    continue-on-error: false
+    needs:
+      - release-docs
+    if: ${{ (github.event_name == 'release') && (github.event.action == 'published') }}
+    steps:
+      - name: Git Checkout
+        uses: actions/[email protected]
+        with:
+          fetch-depth: '0'
+      - name: notify the main repo about the new release of docs package
+        run: |
+          PACKAGE_NAME=$(cat docs/package.json | grep '"name"' | awk -F'"' '{print $4}')
+          PACKAGE_VERSION=$(npm view $PACKAGE_NAME version)
+          curl -L \
+            -X POST \
+            -H "Accept: application/vnd.github+json" \
+            -H "Authorization: token ${{ secrets.PAT_TOKEN }}"\
+              https://api.github.com/repos/zio/zio/dispatches \
+              -d '{
+                    "event_type":"update-docs",
+                    "client_payload":{
+                      "package_name":"'"${PACKAGE_NAME}"'",
+                      "package_version": "'"${PACKAGE_VERSION}"'"
+                    }
+                  }'

README.md

@@ -45,7 +45,7 @@ ZIO Prelude is a library focused on providing a core set of functional data type
 In order to use this library, we need to add the following line in our `build.sbt` file:
 
 ```scala
-libraryDependencies += "dev.zio" %% "zio-prelude" % "1.0.0-RC20"
+libraryDependencies += "dev.zio" %% "zio-prelude" % "1.0.0-RC21"
 ```
 
 ## Example
@@ -94,11 +94,11 @@ Learn more on the [ZIO Prelude homepage](https://zio.dev/zio-prelude/)!
 
 ## Contributing
 
-For the general guidelines, see ZIO [contributor's guide](https://zio.dev/about/contributing).
+For the general guidelines, see ZIO [contributor's guide](https://zio.dev/contributor-guidelines).
 
 ## Code of Conduct
 
-See the [Code of Conduct](https://zio.dev/about/code-of-conduct)
+See the [Code of Conduct](https://zio.dev/code-of-conduct)
 
 ## Support
 

build.sbt

@@ -256,9 +256,7 @@ lazy val docs = project
       experimentalLaws.jvm,
       laws.jvm,
       scalaParallelCollections
-    ),
-    docsPublishBranch                          := "series/2.x",
-    checkArtifactBuildProcessWorkflowStep      := None
+    )
   )
   .settings(macroDefinitionSettings)
   .dependsOn(core.jvm, experimental.jvm, experimentalLaws.jvm, laws.jvm, scalaParallelCollections)

project/plugins.sbt

@@ -15,4 +15,4 @@ addSbtPlugin("org.scalameta"                     % "sbt-mdoc"
 addSbtPlugin("org.scalameta"                     % "sbt-scalafmt"                  % "2.5.0")
 addSbtPlugin("pl.project13.scala"                % "sbt-jcstress"                  % "0.2.0")
 addSbtPlugin("pl.project13.scala"                % "sbt-jmh"                       % "0.4.5")
-addSbtPlugin("dev.zio"                           % "zio-sbt-website"               % "0.3.10")
+addSbtPlugin("dev.zio"                           % "zio-sbt-website"               % "0.4.0-alpha.18")