Update sttpVersion to v3.8.15

.github/workflows/auto-approve.yml

@@ -7,7 +7,7 @@ jobs:
   auto-approve:
     runs-on: ubuntu-20.04
     steps:
-      - uses: hmarr/auto-approve-action@v2.4.0
+      - uses: hmarr/auto-approve-action@v3.1.0
         if: github.actor == 'scala-steward'
         with:
           github-token: "${{ secrets.GITHUB_TOKEN }}"

.github/workflows/ci.yml

@@ -15,9 +15,9 @@ jobs:
       fail-fast: false
       matrix:
         java: ['[email protected]', '[email protected]']
-        scala: ['2.12.16', '2.13.8']
+        scala: ['2.12.17', '2.13.10']
     steps:
-    - uses: actions/checkout@v3.0.2
+    - uses: actions/checkout@v3.1.0
     - uses: olafurpg/setup-scala@v13
       with:
         java-version: ${{ matrix.java }}
@@ -26,14 +26,27 @@ jobs:
     - name: Lint code
       run: sbt check
     - name: Run tests
-      run: sbt ++${{ matrix.scala }}! test IntegrationTest/test
+      run: sbt ++${{ matrix.scala }} test IntegrationTest/test
+
+  website:
+    runs-on: ubuntu-20.04
+    timeout-minutes: 30
+    steps:
+      - name: Checkout current branch
+        uses: actions/[email protected]
+      - name: Setup Scala and Java
+        uses: olafurpg/setup-scala@v13
+      - name: Cache scala dependencies
+        uses: coursier/cache-action@v6
+      - name: Check generation of ScalaDoc
+        run: sbt docs/compileDocs
 
   publish:
     runs-on: ubuntu-20.04
-    needs: [build]
+    needs: [build, website]
     if: github.event_name != 'pull_request'
     steps:
-      - uses: actions/checkout@v3.0.2
+      - uses: actions/checkout@v3.1.0
         with:
           fetch-depth: 0
       - uses: olafurpg/setup-scala@v13

.github/workflows/site.yml

@@ -0,0 +1,98 @@
+# This file was autogenerated using `zio-sbt-website` via `sbt generateGithubWorkflow` 
+# task and should be included in the git repository. Please do not edit it manually.
+
+name: Website
+'on':
+  workflow_dispatch: {}
+  release:
+    types:
+    - published
+  push:
+    branches:
+    - series/2.x
+  pull_request: {}
+jobs:
+  build:
+    name: Build and Test
+    runs-on: ubuntu-latest
+    if: ${{ github.event_name == 'pull_request' }}
+    steps:
+    - name: Git Checkout
+      uses: actions/[email protected]
+      with:
+        fetch-depth: '0'
+    - name: Setup Scala
+      uses: actions/[email protected]
+      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')) || (github.event_name == 'workflow_dispatch') }}
+    steps:
+    - name: Git Checkout
+      uses: actions/[email protected]
+      with:
+        fetch-depth: '0'
+    - name: Setup Scala
+      uses: actions/[email protected]
+      with:
+        distribution: temurin
+        java-version: 17
+        check-latest: true
+    - 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 }}
+  generate-readme:
+    name: Generate README
+    runs-on: ubuntu-latest
+    if: ${{ (github.event_name == 'push') || ((github.event_name == 'release') && (github.event.action == 'published')) }}
+    steps:
+    - name: Git Checkout
+      uses: actions/[email protected]
+      with:
+        ref: ${{ github.head_ref }}
+        fetch-depth: '0'
+    - name: Setup Scala
+      uses: actions/[email protected]
+      with:
+        distribution: temurin
+        java-version: 17
+        check-latest: true
+    - name: Generate Readme
+      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/[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
+        delete-branch: true
+        title: Update README.md

.gitignore

@@ -467,4 +467,6 @@ website/node_modules
 website/build
 website/i18n/en.json
 website/static/api
-.idea
+
+# idea
+.idea

.nvmrc

@@ -1 +1 @@
-16.17.0
+18.12.1

README.md

@@ -1,12 +1,24 @@
-# zio-webhooks
+[//]: # (This file was autogenerated using `zio-sbt-website` plugin via `sbt generateReadme` command.)
+[//]: # (So please do not edit it manually. Instead, change "docs/index.md" file or sbt setting keys)
+[//]: # (e.g. "readmeDocumentation" and "readmeSupport".)
 
-| Project Stage | CI | Release | Snapshot | Discord |
-| --- | --- | --- | --- | --- |
-| [![Project stage][Stage]][Stage-Page] | ![CI][Badge-CI] | [![Release Artifacts][Badge-SonatypeReleases]][Link-SonatypeReleases] | [![Snapshot Artifacts][Badge-SonatypeSnapshots]][Link-SonatypeSnapshots] | [![Badge-Discord]][Link-Discord] |
+# ZIO Webhooks
 
-# Summary
+ZIO Webhooks is a microlibrary for reliable and persistent webhook delivery.
 
-Microlibrary for reliable and persistent webhook delivery.
+[![Development](https://img.shields.io/badge/Project%20Stage-Development-green.svg)](https://github.com/zio/zio/wiki/Project-Stages) ![CI Badge](https://github.com/zio/zio-webhooks/workflows/CI/badge.svg) [![Sonatype Releases](https://img.shields.io/nexus/r/https/oss.sonatype.org/dev.zio/zio-webhooks_2.13.svg?label=Sonatype%20Release)](https://oss.sonatype.org/content/repositories/releases/dev/zio/zio-webhooks_2.13/) [![Sonatype Snapshots](https://img.shields.io/nexus/s/https/oss.sonatype.org/dev.zio/zio-webhooks_2.13.svg?label=Sonatype%20Snapshot)](https://oss.sonatype.org/content/repositories/snapshots/dev/zio/zio-webhooks_2.13/) [![javadoc](https://javadoc.io/badge2/dev.zio/zio-webhooks-docs_2.13/javadoc.svg)](https://javadoc.io/doc/dev.zio/zio-webhooks-docs_2.13) [![ZIO Webhooks](https://img.shields.io/github/stars/zio/zio-webhooks?style=social)](https://github.com/zio/zio-webhooks)
+
+## Introduction
+
+Below is a state diagram for each webhook handled by a server. Note that there aren't any initial or final states as the server doesn't manage the entire lifecycle of webhooks and events—only the subset needed for reliable webhook delivery.
+
+## Installation
+
+Include ZIO Webhooks in your project by adding the following to your `build.sbt`:
+
+```scala
+libraryDependencies += "dev.zio" %% "zio-webhooks" % "0.2.1"
+```
 
 # Getting Started
 
@@ -15,52 +27,57 @@ There are two ways to start a webhook server: as part of the managed constructio
 examples. The managed approach is recommended as it guarantees the server shuts down gracefully. Make sure to
 call `shutdown` on a server created manually. Either way, users will have to implement the following dependencies that are part of `WebhookServer`'s environment:
 
-* [`WebhookRepo`](/webhooks/src/main/scala/zio/webhooks/WebhookRepo.scala) - to get webhooks and update webhook status;
-* [`WebhookEventRepo`](/webhooks/src/main/scala/zio/webhooks/WebhookEventRepo.scala) - to subscribe to events and
+* [`WebhookRepo`](docs/https://github.com/zio/zio-webhooks/tree/series/2.x/webhooks/src/main/scala/zio/webhooks/WebhookRepo.scala) - to get webhooks and update webhook status;
+* [`WebhookEventRepo`](docs/https://github.com/zio/zio-webhooks/tree/series/2.x/webhooks/src/main/scala/zio/webhooks/WebhookEventRepo.scala) - to subscribe to events and
   update event status;
-* [`WebhookHttpClient`](/webhooks/src/main/scala/zio/webhooks/WebhookHttpClient.scala) - to deliver events via HTTP POST
-  ([WebhookSttpClient](/webhooks/src/main/scala/zio/webhooks/backends/sttp/WebhookSttpClient.scala) is provided and ready to use);
-* [`WebhookServerConfig`](/webhooks/src/main/scala/zio/webhooks/WebhookServerConfig.scala) - to specify settings for
+* [`WebhookHttpClient`](docs/https://github.com/zio/zio-webhooks/tree/series/2.x/webhooks/src/main/scala/zio/webhooks/WebhookHttpClient.scala) - to deliver events via HTTP POST
+  (docs/[WebhookSttpClient](https://github.com/zio/zio-webhooks/tree/series/2.x/webhooks/src/main/scala/zio/webhooks/backends/sttp/WebhookSttpClient.scala) is provided and ready to use);
+* [`WebhookServerConfig`](docs/https://github.com/zio/zio-webhooks/tree/series/2.x/webhooks/src/main/scala/zio/webhooks/WebhookServerConfig.scala) - to specify settings for
   error hub capacity, retrying, and batching; and
 * `SerializePayload` - for specifying custom serialization of single and batched event payloads of some content type.
 
+[![](https://mermaid.ink/img/eyJjb2RlIjoic3RhdGVEaWFncmFtLXYyXG4gICAgRW5hYmxlZCAtLT4gRGlzYWJsZWQgOiBkaXNhYmxlZCBleHRlcm5hbGx5XG4gICAgRW5hYmxlZCAtLT4gRW5hYmxlZCA6IGV2ZW50IGRpc3BhdGNoIHN1Y2Nlc3NcbiAgICBEaXNhYmxlZCAtLT4gRW5hYmxlZCA6IGVuYWJsZWQgZXh0ZXJuYWxseVxuICAgIEVuYWJsZWQgLS0-IFJldHJ5aW5nIDogZXZlbnQgZGlzcGF0Y2ggZmFpbHVyZVxuICAgIFJldHJ5aW5nIC0tPiBFbmFibGVkIDogcmV0cnkgcXVldWUgZW1wdGllZFxuICAgIFJldHJ5aW5nIC0tPiBVbmF2YWlsYWJsZSA6IGNvbnRpbnVvdXMgZmFpbHVyZSBmb3IgZHVyYXRpb24gRFxuICAgIFVuYXZhaWxhYmxlIC0tPiBFbmFibGVkIDogZW5hYmxlZCBleHRlcm5hbGx5XG4gICAgVW5hdmFpbGFibGUgLS0-IERpc2FibGVkIDogZGlzYWJsZWQgZXh0ZXJuYWxseSIsIm1lcm1haWQiOnt9LCJ1cGRhdGVFZGl0b3IiOmZhbHNlfQ)](https://mermaid-js.github.io/mermaid-live-editor/#/edit/eyJjb2RlIjoic3RhdGVEaWFncmFtLXYyXG4gICAgRW5hYmxlZCAtLT4gRGlzYWJsZWQgOiBkaXNhYmxlZCBleHRlcm5hbGx5XG4gICAgRW5hYmxlZCAtLT4gRW5hYmxlZCA6IGV2ZW50IGRpc3BhdGNoIHN1Y2Nlc3NcbiAgICBEaXNhYmxlZCAtLT4gRW5hYmxlZCA6IGVuYWJsZWQgZXh0ZXJuYWxseVxuICAgIEVuYWJsZWQgLS0-IFJldHJ5aW5nIDogZXZlbnQgZGlzcGF0Y2ggZmFpbHVyZVxuICAgIFJldHJ5aW5nIC0tPiBFbmFibGVkIDogcmV0cnkgcXVldWUgZW1wdGllZFxuICAgIFJldHJ5aW5nIC0tPiBVbmF2YWlsYWJsZSA6IGNvbnRpbnVvdXMgZmFpbHVyZSBmb3IgZHVyYXRpb24gRFxuICAgIFVuYXZhaWxhYmxlIC0tPiBFbmFibGVkIDogZW5hYmxlZCBleHRlcm5hbGx5XG4gICAgVW5hdmFpbGFibGUgLS0-IERpc2FibGVkIDogZGlzYWJsZWQgZXh0ZXJuYWxseSIsIm1lcm1haWQiOnt9LCJ1cGRhdGVFZGl0b3IiOmZhbHNlfQ)
+```mermaid
+stateDiagram-v2
+    Enabled --> Disabled : disabled externally
+    Enabled --> Enabled : event dispatch success
+    Disabled --> Enabled : enabled externally
+    Enabled --> Retrying : event dispatch failure
+    Retrying --> Enabled : retry queue emptied
+    Retrying --> Unavailable : continuous failure for duration D
+    Unavailable --> Enabled : enabled externally
+    Unavailable --> Disabled : disabled externally
+```
+
 # Example Programs
 
-* [Basic example](/examples/src/main/scala/zio/webhooks/example/BasicExample.scala) - most basic usage with the default configuration. 
-* [Basic example with batching](/examples/src/main/scala/zio/webhooks/example/BasicExampleWithBatching.scala) - same as the basic example but with batching enabled.
-* [Basic example with retrying](/examples/src/main/scala/zio/webhooks/example/BasicExampleWithRetrying.scala) - shows how the server retries when an endpoint fails sometimes.
-* [Custom config example](/examples/src/main/scala/zio/webhooks/example/CustomConfigExample.scala) - a custom configuration example that also showcases batched retries.
-* [Event recovery example](/examples/src/main/scala/zio/webhooks/example/EventRecoveryExample.scala) - shows how the server continues retries after being restarted.
-* [Manual server example](/examples/src/main/scala/zio/webhooks/example/ManualServerExample.scala) - shows how to create, start, and shut down a server programmatically.
-* [Shutdown on first error](/examples/src/main/scala/zio/webhooks/example/ShutdownOnFirstError.scala) - shows how to shut down the server on the first error encountered.
+* [Basic example](docs/https://github.com/zio/zio-webhooks/tree/series/2.x/examples/src/main/scala/zio/webhooks/example/BasicExample.scala) - most basic usage with the default configuration.
+* [Basic example with batching](docs/https://github.com/zio/zio-webhooks/tree/series/2.x/examples/src/main/scala/zio/webhooks/example/BasicExampleWithBatching.scala) - same as the basic example but with batching enabled.
+* [Basic example with retrying](docs/https://github.com/zio/zio-webhooks/tree/series/2.x/examples/src/main/scala/zio/webhooks/example/BasicExampleWithRetrying.scala) - shows how the server retries when an endpoint fails sometimes.
+* [Custom config example](docs/https://github.com/zio/zio-webhooks/tree/series/2.x/examples/src/main/scala/zio/webhooks/example/CustomConfigExample.scala) - a custom configuration example that also showcases batched retries.
+* [Event recovery example](docs/https://github.com/zio/zio-webhooks/tree/series/2.x/examples/src/main/scala/zio/webhooks/example/EventRecoveryExample.scala) - shows how the server continues retries after being restarted.
+* [Manual server example](docs/https://github.com/zio/zio-webhooks/tree/series/2.x/examples/src/main/scala/zio/webhooks/example/ManualServerExample.scala) - shows how to create, start, and shut down a server programmatically.
+* [Shutdown on first error](docs/https://github.com/zio/zio-webhooks/tree/series/2.x/examples/src/main/scala/zio/webhooks/example/ShutdownOnFirstError.scala) - shows how to shut down the server on the first error encountered.
 
-# Documentation
+## Documentation
 
-[ZIO Webhooks Microsite](https://zio.github.io/zio-webhooks/)
+Learn more on the [ZIO Webhooks homepage](https://zio.dev/zio-webhooks/)!
 
-# Contributing
+## Contributing
 
-[Documentation for contributors](https://zio.github.io/zio-webhooks/docs/about/about_contributing)
+For the general guidelines, see ZIO [contributor's guide](https://zio.dev/about/contributing).
 
 ## Code of Conduct
 
-See the [Code of Conduct](https://zio.github.io/zio-webhooks/docs/about/about_coc)
+See the [Code of Conduct](https://zio.dev/about/code-of-conduct)
 
 ## Support
 
 Come chat with us on [![Badge-Discord]][Link-Discord].
 
-# License
-
-[License](LICENSE)
-
-[Badge-SonatypeReleases]: https://img.shields.io/nexus/r/https/oss.sonatype.org/dev.zio/zio-webhooks_2.12.svg "Sonatype Releases"
-[Badge-SonatypeSnapshots]: https://img.shields.io/nexus/s/https/oss.sonatype.org/dev.zio/zio-webhooks_2.12.svg "Sonatype Snapshots"
 [Badge-Discord]: https://img.shields.io/discord/629491597070827530?logo=discord "chat on discord"
-[Link-SonatypeReleases]: https://oss.sonatype.org/content/repositories/releases/dev/zio/zio-webhooks_2.12/ "Sonatype Releases"
-[Link-SonatypeSnapshots]: https://oss.sonatype.org/content/repositories/snapshots/dev/zio/zio-webhooks_2.12/ "Sonatype Snapshots"
 [Link-Discord]: https://discord.gg/2ccFBr4 "Discord"
-[Badge-CI]: https://github.com/zio/zio-webhooks/workflows/CI/badge.svg
-[Stage]: https://img.shields.io/badge/Project%20Stage-Development-green.svg
-[Stage-Page]: https://github.com/zio/zio/wiki/Project-Stages
 
+## License
+
+[License](LICENSE)