Add lychee link checker (#331)

* add lychee link checker

* add .lycheeignore

* ignore https://appassets.androidplatform.net/assets/index.html and fix readme link

* more urls to ignore

Author: breedx-splk

.github/workflows/pr.yaml

@@ -20,3 +20,11 @@ jobs:
 
       - name: Build and test
         run: touch ./local.properties; ./gradlew build javadoc --no-daemon
+  check_links:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Link Checker
+        uses: lycheeverse/[email protected]
+        with:
+          fail: true

.lycheeignore

@@ -0,0 +1,4 @@
+https://rum-ingest/
+https://appassets.androidplatform.net/assets/index.html
+https://appassets.androidplatform.net/assets/first.html
+https://appassets.androidplatform.net/assets/second.html

README.md

@@ -279,7 +279,7 @@ when initializing your instance of the SplunkRum API:
   gives you direct access to the instance of OpenTelemetry that is being used via
   the `getOpenTelemetry()` method. For details on writing manual instrumentation, please refer to
   the [OpenTelemetry docs](https://opentelemetry.io/docs/java/manual_instrumentation/)
-  and [examples](https://github.com/open-telemetry/opentelemetry-java/tree/main/examples).
+  and [examples](https://github.com/open-telemetry/opentelemetry-java-docs#java-opentelemetry-examples).
 - The SplunkRum instance exposes the RUM session ID, in case you wish to provide this to your users
   for troubleshooting purposes. This session ID is generated randomly and contains no PII
   whatsoever.