You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pekko.apache.org by jr...@apache.org on 2023/07/24 11:52:41 UTC

[incubator-pekko-http] branch main updated: Revert old link-validator.conf accidentally deleted in #241 (#267)

This is an automated email from the ASF dual-hosted git repository.

jrudolph pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-pekko-http.git


The following commit(s) were added to refs/heads/main by this push:
     new a360dcf5b Revert old link-validator.conf accidentally deleted in #241 (#267)
a360dcf5b is described below

commit a360dcf5b5a992fec0b867d9d4e673600736e1e9
Author: Johannes Rudolph <jo...@gmail.com>
AuthorDate: Mon Jul 24 13:52:35 2023 +0200

    Revert old link-validator.conf accidentally deleted in #241 (#267)
---
 scripts/link-validator.conf | 99 +++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 99 insertions(+)

diff --git a/scripts/link-validator.conf b/scripts/link-validator.conf
new file mode 100644
index 000000000..4fa2ec130
--- /dev/null
+++ b/scripts/link-validator.conf
@@ -0,0 +1,99 @@
+# SPDX-License-Identifier: Apache-2.0
+
+// 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-http/1.0.0/"
+      replace = ""
+    }
+    {
+      prefix = "https://pekko.apache.org/docs/pekko-http/current/"
+      replace = ""
+    }
+    # ScalaDoc from unidoc
+    {
+      prefix = "https://pekko.apache.org/api/pekko-http/1.0.0/"
+      replace = "/../../../../../target/scala-2.13/unidoc/"
+    }
+    {
+      prefix = "https://pekko.apache.org/api/pekko-http/current/"
+      replace = "/../../../../../target/scala-2.13/unidoc/"
+    }
+    {
+      prefix = "https://pekko.apache.org/api/pekko-http/snapshot/"
+      replace = "/../../../../../target/scala-2.13/unidoc/"
+    }
+    # Java APIs from genjavadoc
+    {
+      prefix = "https://pekko.apache.org/japi/pekko-http/1.0.0/"
+      replace = "/../../../../../target/javaunidoc/"
+    }
+    {
+      prefix = "https://pekko.apache.org/japi/pekko-http/current/"
+      replace = "/../../../../../target/javaunidoc/"
+    }
+    {
+      prefix = "https://pekko.apache.org/japi/pekko-http/snapshot/"
+      replace = "/../../../../../target/javaunidoc/"
+    }
+  ]
+
+  ignore-missing-local-files-regex = ""
+  // e.g. "^api/alpakka/snapshot/pekko/stream/alpakka/googlecloud/storage/impl/Formats.*"
+
+  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/"
+    # Problematic link generated by scaladoc
+    "https://www.scala-lang.org/api/2.13.11/scala/runtime/AbstractFunction1.html"
+    # Bug, see https://github.com/scala/bug/issues/12807 and https://github.com/lampepfl/dotty/issues/17973
+    "https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/nio/file/StandardOpenOption$.html"
+    # Occasionally returns a 500 Internal Server Error
+    "http://code.google.com/"
+    # sample endpoint
+    "http://localhost:8080"
+    # broken URL in license report
+    "http://pholser.github.com/"
+  ]
+
+  non-https-whitelist = [
+    # sample in docs
+    "http://example.com"
+    # license report
+    "http://asm.ow2.io/"
+    "http://commons.apache.org/"
+    "http://www.apache.org/licenses/LICENSE-2.0"
+    "http://findbugs.sourceforge.net/"
+    "http://github.com/FasterXML/"
+    "http://github.com/ronmamo/"
+    "http://github.com/sbt/junit-interface/"
+    "http://junit.org"
+    "http://netty.io/"
+    "http://openjdk.java.net/legal/gplv2+ce.html"
+    "http://opensource.org/licenses/MIT"
+    "http://parboiled.org"
+    "http://specs2.org/"
+    "http://www.eclipse.org/legal/epl-v10.html"
+    "http://www.javassist.org/"
+    "http://www.mozilla.org/MPL/MPL-1.1.html"
+    "http://www.opensource.org/licenses/"
+    "http://www.reactive-streams.org/"
+    "http://www.scala-lang.org/"
+    "http://www.scala-sbt.org"
+    "http://www.scalacheck.org"
+    "http://www.scalatest.org"
+    "http://www.slf4j.org"
+    # no https support
+    "http://spray.io/blog/"
+    # javadoc
+    "http://tools.ietf.org/html/rfc7541"
+  ]
+}


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@pekko.apache.org
For additional commands, e-mail: commits-help@pekko.apache.org