You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pekko.apache.org by fa...@apache.org on 2023/07/23 07:40:54 UTC
[incubator-pekko-connectors-kafka] branch main updated: run link validator (#95)
This is an automated email from the ASF dual-hosted git repository.
fanningpj pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-pekko-connectors-kafka.git
The following commit(s) were added to refs/heads/main by this push:
new ca5eefd6 run link validator (#95)
ca5eefd6 is described below
commit ca5eefd6bbee9ce43e0fdddc8724f7e052be804f
Author: PJ Fanning <pj...@users.noreply.github.com>
AuthorDate: Sun Jul 23 08:40:48 2023 +0100
run link validator (#95)
* run link validator
try to fix links
Update Versions.scala
try to fix build
Update link-validator.conf
Update link-validator.conf
Update home.md
merge problem
* Update link-validator.conf
---
.github/workflows/link-validator.yml | 33 ++++++++++++++++++---------------
docs/src/main/paradox/home.md | 6 +++---
project/ParadoxSettings.scala | 6 ++++--
project/Versions.scala | 3 +++
scripts/link-validator.conf | 19 +++++++++++++------
5 files changed, 41 insertions(+), 26 deletions(-)
diff --git a/.github/workflows/link-validator.yml b/.github/workflows/link-validator.yml
index 640eb27c..c9f92c55 100644
--- a/.github/workflows/link-validator.yml
+++ b/.github/workflows/link-validator.yml
@@ -1,12 +1,12 @@
-# TODO: Fix after documentation updates
name: Link Validator
+permissions: {}
+
on:
pull_request:
-## schedule:
-## - cron: '0 6 * * 1'
-
-permissions: {}
+ workflow_dispatch:
+ schedule:
+ - cron: '0 6 * * 1'
jobs:
validate-links:
@@ -23,20 +23,23 @@ jobs:
#- name: Fetch tags
# run: git fetch --depth=100 origin +refs/tags/*:refs/tags/*
- - name: Setup Java 11
+ - name: Setup Java 8
uses: actions/setup-java@v3
with:
distribution: temurin
- java-version: 11
+ java-version: 8
- name: Cache Coursier cache
uses: coursier/cache-action@v6
- - name: sbt site
- run: sbt docs/makeSite
-#
-# - name: Install Coursier command line tool
-# run: curl -fLo cs https://git.io/coursier-cli-linux && chmod +x cs && ./cs
-#
-# - name: Run Link Validator
-# run: ./cs launch net.runne::site-link-validator:0.2.2 -- scripts/link-validator.conf
+ - name: Setup Coursier
+ uses: coursier/setup-action@v1.3.3
+
+ - name: Build Documentation
+ run: |-
+ sbt docs/paradox unidoc
+ env:
+ JAVA_OPTS: "-verbose:gc -Xmx4g"
+
+ - name: Run Link Validator
+ run: cs launch net.runne::site-link-validator:0.2.2 -- scripts/link-validator.conf
diff --git a/docs/src/main/paradox/home.md b/docs/src/main/paradox/home.md
index c7783d85..6f7344be 100644
--- a/docs/src/main/paradox/home.md
+++ b/docs/src/main/paradox/home.md
@@ -10,9 +10,9 @@ This **Apache Pekko Connectors Kafka connector** lets you connect [Apache Kafka]
## Matching Kafka Versions
-| Kafka client | Scala Versions | Apache Pekko version | Apache Pekko Connectors Kafka Connector
-|------------------------------------------------------------------------------------|----------------|----------------------|-------------------------
-| [3.0.1](https://dist.apache.org/repos/dist/release/kafka/3.0.1/RELEASE_NOTES.html) | 2.13 | 1.0.0 | 1.0.0
+| Kafka client | Scala Versions | Apache Pekko version | Apache Pekko Connectors Kafka Connector
+|-------------------------------------------------------------------------|----------------|----------------------|-------------------------
+| [3.0.1](https://archive.apache.org/dist/kafka/3.0.1/RELEASE_NOTES.html) | 2.12, 2.13, 3 | 1.0.0 | 1.0.0
@@@ note
diff --git a/project/ParadoxSettings.scala b/project/ParadoxSettings.scala
index 23cfaee7..e88d3a1d 100644
--- a/project/ParadoxSettings.scala
+++ b/project/ParadoxSettings.scala
@@ -33,8 +33,10 @@ object ParadoxSettings {
"extref.pekko.base_url" -> s"$pekkoDocs/pekko/$pekkoVersionForDocs/%s",
"scaladoc.org.apache.pekko.base_url" -> s"$pekkoAPI/pekko/$pekkoVersionForDocs/",
"javadoc.org.apache.pekko.base_url" -> s"$pekkoAPI/pekko/$pekkoVersionForDocs/",
- "javadoc.pekko.link_style" -> "direct",
- "extref.pekko-management.base_url" -> s"$pekkoDocs/pekko-management/$pekkoVersionForDocs/%s",
+ "scaladoc.org.apache.pekko.kafka.base_url" -> s"$pekkoAPI/pekko-connectors-kafka/$pekkoConnectorsKafkaVersionForDocs/",
+ "javadoc.org.apache.pekko.kafka.base_url" -> s"$pekkoAPI/pekko-connectors-kafka/$pekkoConnectorsKafkaVersionForDocs/",
+ "javadoc.org.apache.pekko.link_style" -> "direct",
+ "extref.pekko-management.base_url" -> s"$pekkoDocs/pekko-management/$pekkoManagementVersionForDocs/%s",
// Kafka
"kafka.version" -> kafkaVersion,
"extref.kafka.base_url" -> s"https://kafka.apache.org/$KafkaVersionForDocs/%s",
diff --git a/project/Versions.scala b/project/Versions.scala
index 8ff3eb44..eab122b5 100644
--- a/project/Versions.scala
+++ b/project/Versions.scala
@@ -21,6 +21,8 @@ object Versions {
val Scala3 = "3.3.0"
val pekkoVersionForDocs = "current"
+ val pekkoConnectorsKafkaVersionForDocs = "current"
+ val pekkoManagementVersionForDocs = "current"
val pekkoVersion = "1.0.0"
// Keep .scala-steward.conf pin in sync
@@ -43,6 +45,7 @@ object Versions {
ExclusionRule("org.apache.kafka"))
val pekkoAPI = "https://pekko.apache.org/api"
+ val pekkoJavaAPI = "https://pekko.apache.org/japi"
val pekkoDocs = "https://pekko.apache.org/docs"
}
diff --git a/scripts/link-validator.conf b/scripts/link-validator.conf
index c211f47c..64cfa219 100644
--- a/scripts/link-validator.conf
+++ b/scripts/link-validator.conf
@@ -1,18 +1,23 @@
// config for https://github.com/ennru/site-link-validator/
site-link-validator {
- root-dir = "./docs/target/site/"
+ root-dir = "docs/target/paradox/site/main/"
# relative to `root-dir`
- start-file = "docs/alpakka-kafka/snapshot/index.html"
+ start-file = "index.html"
# Resolves URLs with the given prefix as local files instead
link-mappings = [
{
- prefix = "https://doc.akka.io/docs/alpakka-kafka/snapshot/"
- replace = "/docs/alpakka-kafka/snapshot/"
+ prefix = "https://pekko.apache.org/docs/pekko-connectors-kafka/current/"
+ replace = ""
}
+ # ScalaDoc from unidoc
{
- prefix = "https://doc.akka.io/api/alpakka-kafka/snapshot/"
- replace = "/api/alpakka-kafka/snapshot/"
+ 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/"
}
]
@@ -21,6 +26,8 @@ site-link-validator {
ignore-prefixes = [
# runtime is part of the published Scaladoc
"https://www.scala-lang.org/api/2.13.11/scala/runtime/AbstractFunction2.html"
+ # Javadoc link that points to wrong file name (should have $ at end of file name)
+ "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
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@pekko.apache.org
For additional commands, e-mail: commits-help@pekko.apache.org