refactor(build): demo zio-sbt pr 440 changes

.github/workflows/ci.yml

@@ -1,135 +1,267 @@
-name: CI
+# This file was autogenerated using `zio-sbt-ci` plugin via `sbt ciGenerateGithubWorkflow` 
+# task and should be included in the git repository. Please do not edit it manually.
 
+name: CI
 env:
-  JDK_JAVA_OPTIONS: -XX:+PrintCommandLineFlags # JDK_JAVA_OPTIONS is _the_ env. variable to use for modern Java
-  JVM_OPTS: -XX:+PrintCommandLineFlags # for Java 8 only (sadly, it is not modern enough for JDK_JAVA_OPTIONS)
-
-on:
-  pull_request:
-  push:
-    branches: ['series/2.x']
+  JDK_JAVA_OPTIONS: -XX:+PrintCommandLineFlags
+'on':
+  workflow_dispatch: {}
   release:
     types:
       - published
-
+  pull_request:
+    branches-ignore:
+      - gh-pages
+  push:
+    branches:
+      - series/2.x
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref == format('refs/heads/{0}', github.event.repository.default_branch) && github.run_id || github.ref }}
+  cancel-in-progress: true
 jobs:
-  lint:
-    runs-on: ubuntu-20.04
-    timeout-minutes: 30
+  build:
+    name: Build
+    runs-on: ubuntu-latest
+    continue-on-error: true
     steps:
-      - name: Checkout current branch
-        uses: actions/checkout@v4.1.2
+      - name: Git Checkout
+        uses: actions/checkout@v4
         with:
-          fetch-depth: 0
-      - name: Setup Java
-        uses: actions/[email protected]
+          fetch-depth: '0'
+      - name: Install libuv
+        run: sudo apt-get update && sudo apt-get install -y libuv1-dev
+      - name: Setup Scala
+        uses: actions/setup-java@v4
         with:
-          distribution: temurin
-          java-version: 21
-          check-latest: true
-      - name: Cache scala dependencies
+          distribution: corretto
+          java-version: '17'
+          check-latest: 'true'
+      - name: Cache Dependencies
         uses: coursier/cache-action@v6
-      - name: Lint code
-        run: sbt check
-
-  benchmarks:
-    runs-on: ubuntu-20.04
-    strategy:
-      fail-fast: false
-      matrix:
-        java: ['17', '21']
-        scala: ['2.13.15']
+      - name: Check all code compiles
+        run: sbt +Test/compile
+      - name: Check artifacts build process
+        run: sbt +publishLocal
+      - name: Check website build process
+        run: sbt docs/clean; sbt docs/buildWebsite
+  lint:
+    name: Lint
+    runs-on: ubuntu-latest
+    continue-on-error: false
     steps:
-      - name: Checkout current branch
-        uses: actions/checkout@v4.1.2
+      - name: Git Checkout
+        uses: actions/checkout@v4
         with:
-          fetch-depth: 0
-      - name: Setup Java
-        uses: actions/[email protected]
+          fetch-depth: '0'
+      - name: Install libuv
+        run: sudo apt-get update && sudo apt-get install -y libuv1-dev
+      - name: Setup Scala
+        uses: actions/setup-java@v4
         with:
-          distribution: temurin
-          java-version: ${{ matrix.java }}
-          check-latest: true
-      - name: Cache scala dependencies
+          distribution: corretto
+          java-version: '17'
+          check-latest: 'true'
+      - name: Cache Dependencies
         uses: coursier/cache-action@v6
-      - name: Compile benchmarks
-        run: sbt ++${{ matrix.scala }}! jmh:compile
-
-  mdoc:
-    runs-on: ubuntu-20.04
-    timeout-minutes: 60
-    steps:
-      - name: Checkout current branch
-        uses: actions/[email protected]
-      - name: Setup Java
-        uses: actions/[email protected]
-        with:
-          distribution: temurin
-          java-version: 8
-          check-latest: true
-      - name: Cache scala dependencies
-        uses: coursier/cache-action@v6
-      - name: Check Document Generation
-        run: sbt compileDocs
-
+      - name: Check if the site workflow is up to date
+        run: sbt ciCheckGithubWorkflow
+      - name: Lint
+        run: sbt lint
   test:
-    runs-on: ubuntu-20.04
-    timeout-minutes: 30
+    name: Test
+    runs-on: ubuntu-latest
+    continue-on-error: false
     strategy:
-      fail-fast: false
       matrix:
-        java: ['17', '21']
-        scala: ['2.12.19', '2.13.15', '3.3.4']
-        platform: ['JVM', 'JS', 'Native']
+        java:
+          - '11'
+          - '17'
+          - '21'
+        scalaVersion:
+          - 2.12.20
+          - 2.13.15
+          - 3.3.4
+        scalaPlatform:
+          - JS
+          - JVM
+          - Native
+      fail-fast: false
     steps:
-      - name: Checkout current branch
-        uses: actions/[email protected]
-        with:
-          fetch-depth: 0
-      - name: Setup Java
-        uses: actions/[email protected]
+      - name: Install libuv
+        run: sudo apt-get update && sudo apt-get install -y libuv1-dev
+      - name: Setup Scala
+        uses: actions/setup-java@v4
         with:
-          distribution: temurin
+          distribution: corretto
           java-version: ${{ matrix.java }}
-          check-latest: true
-      - name: Cache scala dependencies
+          check-latest: 'true'
+      - name: Cache Dependencies
         uses: coursier/cache-action@v6
+      - name: Git Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: '0'
+      - name: Test
+        run: sbt +test${{ matrix.scalaPlatform }}${{ startsWith(matrix.scalaVersion, '2.12') && '2_12' || (startsWith(matrix.scalaVersion, '2.13') && '2_13' || (startsWith(matrix.scalaVersion, '3') && '3' || '')) }}
+  update-readme:
+    name: Update README
+    runs-on: ubuntu-latest
+    continue-on-error: false
+    if: ${{ github.event_name == 'push' }}
+    steps:
+      - name: Git Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: '0'
       - name: Install libuv
-        if: matrix.platform == 'Native'
         run: sudo apt-get update && sudo apt-get install -y libuv1-dev
-      - name: Run Macros tests
-        if: ${{ !startsWith(matrix.scala, '3.3.') }}
-        run: sbt ++${{ matrix.scala }}! testScala2${{ matrix.platform }}
-      - name: Run tests
-        run: sbt ++${{ matrix.scala }}! test${{ matrix.platform }}
+      - name: Setup Scala
+        uses: actions/setup-java@v4
+        with:
+          distribution: corretto
+          java-version: '17'
+          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/create-pull-request@v6
+        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-20.04
-    needs: [lint, mdoc, benchmarks, test]
+    name: ci
+    runs-on: ubuntu-latest
+    continue-on-error: false
+    needs:
+      - lint
+      - test
+      - build
     steps:
-      - name: Aggregate of lint, and all tests
+      - name: Report Successful CI
         run: echo "ci passed"
-
-  publish:
-    runs-on: ubuntu-20.04
-    timeout-minutes: 60
-    needs: [ci]
-    if: github.event_name != 'pull_request'
+  release:
+    name: Release
+    runs-on: ubuntu-latest
+    continue-on-error: false
+    needs:
+      - ci
+    if: ${{ github.event_name != 'pull_request' }}
     steps:
-      - name: Checkout current branch
-        uses: actions/checkout@v4.1.2
+      - name: Git Checkout
+        uses: actions/checkout@v4
         with:
-          fetch-depth: 0
-      - name: Setup Java
-        uses: actions/[email protected]
+          fetch-depth: '0'
+      - name: Install libuv
+        run: sudo apt-get update && sudo apt-get install -y libuv1-dev
+      - name: Setup Scala
+        uses: actions/setup-java@v4
         with:
-          distribution: temurin
-          java-version: 8
-          check-latest: true
+          distribution: corretto
+          java-version: '17'
+          check-latest: 'true'
+      - name: Cache Dependencies
+        uses: coursier/cache-action@v6
       - name: Release
         run: sbt ci-release
         env:
           PGP_PASSPHRASE: ${{ secrets.PGP_PASSPHRASE }}
           PGP_SECRET: ${{ secrets.PGP_SECRET }}
           SONATYPE_PASSWORD: ${{ secrets.SONATYPE_PASSWORD }}
           SONATYPE_USERNAME: ${{ secrets.SONATYPE_USERNAME }}
+          CI_RELEASE: +publishSigned
+          CI_SNAPSHOT_RELEASE: +publish
+  release-docs:
+    name: Release Docs
+    runs-on: ubuntu-latest
+    continue-on-error: false
+    needs:
+      - release
+    if: ${{ ((github.event_name == 'release') && (github.event.action == 'published')) || (github.event_name == 'workflow_dispatch') }}
+    steps:
+      - name: Git Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: '0'
+      - name: Install libuv
+        run: sudo apt-get update && sudo apt-get install -y libuv1-dev
+      - name: Setup Scala
+        uses: actions/setup-java@v4
+        with:
+          distribution: corretto
+          java-version: '17'
+          check-latest: 'true'
+      - name: Cache Dependencies
+        uses: coursier/cache-action@v6
+      - name: Setup NodeJs
+        uses: actions/setup-node@v4
+        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/checkout@v4
+        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

@@ -25,7 +25,7 @@ The goal of this project is to create the best all-round JSON library for Scala:
 In order to use this library, we need to add the following line in our `build.sbt` file:
 
 ```scala
-libraryDependencies += "dev.zio" %% "zio-json" % "0.6.2"
+libraryDependencies += "dev.zio" %% "zio-json" % "0.7.0"
 ```
 
 ## Example