Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

link validator: ignore license report #400

Merged
merged 2 commits into from
Nov 28, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .github/workflows/link-validator.yml
Original file line number Diff line number Diff line change
Expand Up @@ -39,5 +39,6 @@ jobs:
- name: Run Link Validator
run: |
VERSION=$(ls docs/target/site/docs/pekko-grpc)
echo "Version is $VERSION"
sed -e "s/snapshot/$VERSION/" scripts/link-validator.conf > /tmp/link-validator.conf
cs launch net.runne::site-link-validator:0.2.2 -- /tmp/link-validator.conf
cs launch net.runne::site-link-validator:0.2.5 -- /tmp/link-validator.conf
2 changes: 1 addition & 1 deletion docs/src/main/paradox/apidesign.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# API Design

When designing a gRPC API, you could take into consideration some of the
[Google Cloud API Design Patterns](https://cloud.google.com/apis/design/design_patterns).
[Google Cloud API Design Patterns](https://google.aip.dev/general#design-patterns).

## Methods without request or response

Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/paradox/client/details.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ Java

## Rich error model

Beyond status codes you can also use the [Rich error model](https://grpc.io/docs/guides/error/#richer-error-model). Currently there is no particular support for consuming such error objects (such as the ones based on the [common protobuf](https://cloud.google.com/apis/design/errors#error_model), but you can obtain them 'manually'.
Beyond status codes you can also use the [Rich error model](https://grpc.io/docs/guides/error/#richer-error-model). Currently there is no particular support for consuming such error objects (such as the ones based on the [common protobuf](https://google.aip.dev/193), but you can obtain them 'manually'.

Extract the `StatusRuntimeException` and parse the Rich error model to access `code`, `message` and `details`. Then find the details you are looking for based on their `typeUrl` and unpack them:

Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/paradox/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,5 @@ To try out Pekko gRPC and understand how the development process might work out,

## Video Introduction

The Akka team have a [video](https://doc.akka.io/docs/akka-grpc/current/getting-started.html#video-introduction).
The Akka team have a [video](https://doc.akka.io/libraries/akka-grpc/current/getting-started.html#video-introduction).
Much of what is discussed is relevant to Pekko gRPC.
2 changes: 1 addition & 1 deletion docs/src/main/paradox/release-notes/releases-1.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ there are security issues published for those versions.

## 1.0.0
Apache Pekko gRPC 1.0.0 is based on Akka gRPC 2.1.6. Pekko came about as a result of Lightbend's decision to make future
Akka releases under a [Business Software License](https://www.lightbend.com/blog/why-we-are-changing-the-license-for-akka),
Akka releases under a [Business Software License](https://akka.io/blog/why-we-are-changing-the-license-for-akka),
a license that is not compatible with Open Source usage.

Apache Pekko has changed the package names, among other changes. Config names have changed to use `pekko` instead
Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/paradox/server/kubernetes.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ route.

## Google Cloud Endpoints

The Google cloud has a [Cloud Endpoints](https://cloud.google.com/endpoints) feature that
The Google cloud has a [Cloud Endpoints](https://cloud.google.com/endpoints/docs) feature that
allows exposing a gRPC API in a more 'controlled' way: you can configure API key management,
authentication, monitoring quote/rate limiting, generate a 'developer portal' for your API's users
and much more. You need to provide your `.proto` definitions when creating the endpoint, and
Expand Down
46 changes: 6 additions & 40 deletions scripts/link-validator.conf
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# SPDX-License-Identifier: Apache-2.0

site-link-validator {
root-dir = "./docs/target/site/"
root-dir = "docs/target/site/"
# relative to `root-dir`
start-file = "docs/pekko-grpc/snapshot/index.html"

Expand All @@ -19,54 +19,20 @@ site-link-validator {

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

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

ignore-prefixes = [
# GitHub will block with "429 Too Many Requests"
"https://github.com/apache/pekko-grpc/"
# MVN repository forbids access after a few requests
"https://mvnrepository.com/artifact/"
# Github links generated by sbt-license-report
"http://pholser.github.com/jopt-simple"
"https://github.com/googleapis/java-iam/proto-google-common-protos"
"https://github.com/netty/netty-tcnative/netty-tcnative-boringssl-static"
# Other links generated by sbt-license-report
"http://lmax-exchange.github.com/disruptor"
# Occasionally returns a 500 Internal Server Error
"http://code.google.com/"
]

non-https-whitelist = [
# license report
"http://www.jetbrains.org",
"http://aopalliance.sourceforge.net",
"http://asm.ow2.io/",
"http://checkerframework.org",
"http://code.google.com/p/",
"http://commons.apache.org/proper/",
"http://findbugs.sourceforge.net/",
"http://fusesource.github.io/jansi",
"http://github.com/typelevel/jawn"
"http://hc.apache.org/",
"http://hdrhistogram.github.io/HdrHistogram/",
"http://jcp.org/en/jsr/detail?id=250",
"http://junit.org",
"http://lmax-exchange.github.com/disruptor",
"http://openjdk.java.net/legal/gplv2+ce.html",
"http://opensource.org/licenses/",
"http://www.opensource.org/licenses/",
"http://parboiled.org",
"http://pholser.github.com/jopt-simple",
"http://source.android.com/",
"http://www.apache.org/licenses",
"http://www.eclipse.org/legal/",
"http://www.gnu.org/licenses/",
"http://www.jcraft.com/jsch/",
"http://www.reactive-streams.org/",
"http://www.scala-lang.org/",
"http://www.scala-sbt.org",
"http://www.scalatest.org",
"http://www.slf4j.org",
"http://creativecommons.org/"
"http://jopt-simple.github.io/"
"http://jspecify.org/"
]
}
Loading