Skip to content

Commit

Permalink
link validator CI failing (#919)
Browse files Browse the repository at this point in the history
* link validator CI failing

* Update link-validator.conf

* Update link-validator.conf

* http links

* Update versioning.md

* try to fix more issues

* Update link-validator.conf

* Update link-validator.conf

* try to fix azure link

* Update link-validator.yml
  • Loading branch information
pjfanning authored Dec 10, 2024
1 parent 26a0ae1 commit 54a747c
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 5 deletions.
2 changes: 1 addition & 1 deletion build.sbt
Original file line number Diff line number Diff line change
Expand Up @@ -402,7 +402,7 @@ lazy val docs = project
// Pekko gRPC
"pekko-grpc.version" -> Dependencies.PekkoGrpcBinaryVersion,
"extref.pekko-grpc.base_url" -> s"https://pekko.apache.org/docs/pekko-grpc/${Dependencies.PekkoGrpcBinaryVersion}/%s",
"scaladoc.org.apache.pekko.gprc.base_url" -> s"https://pekko.apache.org/api/pekko-grpc/${Dependencies.PekkoGrpcBinaryVersion}/",
"scaladoc.org.apache.pekko.gprc.base_url" -> s"https://pekko.apache.org/api/pekko-grpc/${Dependencies.PekkoGrpcBinaryVersion}/org/apache/pekko/gprc",
// Couchbase
"couchbase.version" -> Dependencies.CouchbaseVersion,
"extref.couchbase.base_url" -> s"https://docs.couchbase.com/java-sdk/${Dependencies.CouchbaseVersionForDocs}/%s",
Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/paradox/azure-storage-queue.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

The Azure Storage Queue connector provides an Apache Pekko Stream Source and Sinks for Azure Storage Queue integration.

Azure Storage Queue is a queuing service similar to Amazon's SQS. It is designed mostly for long-running and non-time-critical tasks. For more information on Azure Storage Queue see the [Azure docs](https://azure.microsoft.com/en-us/services/storage/queues/).
Azure Storage Queue is a queuing service similar to Amazon's SQS. It is designed mostly for long-running and non-time-critical tasks. For more information on Azure Storage Queue see the [Azure docs](https://azure.microsoft.com/en-us/products/storage/queues).

@@project-info{ projectId="azure-storage-queue" }

Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/paradox/other-docs/versioning.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Apache Pekko Connectors publishes

* regular releases to [Maven Central](https://search.maven.org/search?q=g:org.pekko%20pekko-connectors-)
* milestone and release candidates (of major versions) to Maven Central
* @ref:[snapshots](snapshots.md) to [Sonatype](https://oss.sonatype.org/content/repositories/snapshots/org/pekko/)
* @ref:[snapshots](snapshots.md) to [repository.apache.org](https://repository.apache.org/content/groups/snapshots/org/apache/pekko/)

### Compatibility

Expand Down
12 changes: 10 additions & 2 deletions scripts/link-validator.conf
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

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

Expand All @@ -23,7 +23,7 @@ site-link-validator {

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

ignore-prefixes = [
Expand All @@ -39,10 +39,18 @@ site-link-validator {
"https://mvnrepository.com/artifact/"
# Errors in Scaladoc from Google Common header `X-Upload-Content-Type`
"https://doc.akka.io/api/akka-http/10.2.9/akka/http/impl/util/"
# Invalid links generated in Google Common Connector scaladoc
"https://pekko.apache.org/api/pekko-http/"
# Invalid links generated in Google Pubsub Connector scaladoc
"https://pekko.apache.org/api/pekko-grpc/"
]

non-https-whitelist = [
# generated by @apidoc
"http://pravega.io/"
# no https support
"http://reactivemongo.org"
# need to investigate why scaladoc links are http
"http://www.scala-lang.org/api"
]
}

0 comments on commit 54a747c

Please sign in to comment.