diff --git a/.github/workflows/link-validator.yml b/.github/workflows/link-validator.yml index 087ac7bc5..16a280694 100644 --- a/.github/workflows/link-validator.yml +++ b/.github/workflows/link-validator.yml @@ -44,3 +44,9 @@ jobs: - name: Run Link Validator run: cs launch net.runne::site-link-validator:0.2.5 -- scripts/link-validator.conf + + - name: Run Link Validator (Distributed cluster) + run: cs launch net.runne::site-link-validator:0.2.5 -- scripts/link-validator-distributed-cluster.conf + + - name: Run Link Validator (Edge) + run: cs launch net.runne::site-link-validator:0.2.5 -- scripts/link-validator-edge.conf diff --git a/project/Common.scala b/project/Common.scala index 05ade30d6..2c45129da 100644 --- a/project/Common.scala +++ b/project/Common.scala @@ -17,7 +17,7 @@ object Common extends AutoPlugin { Seq( organization := "com.lightbend.akka", organizationName := "Lightbend Inc.", - organizationHomepage := Some(url("https://www.lightbend.com/")), + organizationHomepage := Some(url("https://akka.io/")), startYear := Some(2020), homepage := Some(url("https://akka.io")), // apiURL defined in projectSettings because version.value is not correct here diff --git a/project/plugins.sbt b/project/plugins.sbt index 64822a3c7..ea8fc77b4 100644 --- a/project/plugins.sbt +++ b/project/plugins.sbt @@ -10,7 +10,7 @@ addSbtPlugin("com.github.sbt" % "sbt-ci-release" % "1.9.0") addSbtPlugin("com.lightbend.akka.grpc" % "sbt-akka-grpc" % "2.5.0") // Documentation -addSbtPlugin("io.akka" % "sbt-paradox-akka" % "24.10.5") +addSbtPlugin("io.akka" % "sbt-paradox-akka" % "24.10.6") addSbtPlugin("com.lightbend.paradox" % "sbt-paradox-dependencies" % "0.2.4") addSbtPlugin("com.lightbend.sbt" % "sbt-publish-rsync" % "0.3") addSbtPlugin("com.github.sbt" % "sbt-unidoc" % "0.5.0") diff --git a/scripts/link-validator-distributed-cluster.conf b/scripts/link-validator-distributed-cluster.conf new file mode 100644 index 000000000..5805f3ee4 --- /dev/null +++ b/scripts/link-validator-distributed-cluster.conf @@ -0,0 +1,36 @@ +// config for https://github.com/ennru/site-link-validator/ +site-link-validator { + root-dir = "./akka-distributed-cluster-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://doc.akka.io/libraries/akka-distributed-cluster/snapshot/" + replace = "/docs/akka-distributed-cluster/snapshot/" + } + { + prefix = "https://doc.akka.io/api/akka-distributed-cluster/snapshot/" + replace = "/api/akka-distributed-cluster/snapshot/" + } + ] + + ignore-missing-local-files-regex = "" + + ignore-files = [] + + ignore-prefixes = [ + # Fails after a number of requests with "403 Forbidden" + "https://javadoc.io/static/" + # GitHub will block with "429 Too Many Requests" + "https://github.com/" + # MVN repository forbids access after a few requests + "https://mvnrepository.com/artifact/" + # link checker is using HEAD requests, which isn't supported by the repo index + "https://repo.akka.io/" + ] + + non-https-whitelist = [ + ] +} diff --git a/scripts/link-validator-edge.conf b/scripts/link-validator-edge.conf new file mode 100644 index 000000000..7841596e8 --- /dev/null +++ b/scripts/link-validator-edge.conf @@ -0,0 +1,37 @@ +// config for https://github.com/ennru/site-link-validator/ +site-link-validator { + root-dir = "./akka-edge-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://doc.akka.io/libraries/akka-edge/snapshot/" + replace = "/docs/akka-edge/snapshot/" + } + { + prefix = "https://doc.akka.io/api/akka-edge/snapshot/" + replace = "/api/akka-edge/snapshot/" + } + ] + + ignore-missing-local-files-regex = "" + + ignore-files = [] + + ignore-prefixes = [ + # Fails after a number of requests with "403 Forbidden" + "https://javadoc.io/static/" + # GitHub will block with "429 Too Many Requests" + "https://github.com/" + # MVN repository forbids access after a few requests + "https://mvnrepository.com/artifact/" + # link checker is using HEAD requests, which isn't supported by the repo index + "https://repo.akka.io/", + "http://localhost:8081/" + ] + + non-https-whitelist = [ + ] +}