scripts/link-validator.conf

// config for https://github.com/ennru/site-link-validator/
site-link-validator {
  root-dir = "docs/target/paradox/site/main/"
  # relative to `root-dir`
  start-file = "index.html"

  # Resolves URLs with the given prefix as local files instead
  link-mappings = [
    {
      prefix = "https://pekko.apache.org/docs/pekko-connectors-kafka/current/"
      replace = ""
    }
    # ScalaDoc from unidoc
    {
      prefix = "https://pekko.apache.org/api/pekko-connectors-kafka/current/"
      replace = "/../../../../../target/scala-2.13/unidoc/"
    }
    {
      prefix = "https://pekko.apache.org/api/pekko-connectors-kafka/snapshot/"
      replace = "/../../../../../target/scala-2.13/unidoc/"
    }
  ]

  ignore-missing-local-files-regex = ""

  ignore-files = [
    # This file is generated, we can't do much about the invalid links here
    "license-report.html"
  ]

  ignore-prefixes = [
    # runtime is part of the published Scaladoc
    "https://www.scala-lang.org/api/2.13.16/scala/runtime/AbstractFunction2.html"
    # Javadoc link that points to wrong file name (should have $ at end of file name)
    "https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration$.html"
    "https://pekko.apache.org/api/pekko/current/org/apache/pekko/stream/testkit/javadsl/StreamTestKit.html"
    # GitHub will block with "429 Too Many Requests"
    "https://github.com/"
    # MVN repository forbids access after a few requests
    "https://mvnrepository.com/artifact/"
    # gives: javax.net.ssl.SSLHandshakeException: Received fatal alert: handshake_failure requests
    "https://javadoc.io/static/"
    # The address is hit too often and blocked
    "https://opensource.org/licenses/Apache-2.0"
  ]

  non-https-whitelist = [

  ]
}