From deaf8f90c479d9d5d18b197fb8f7f3fc4c9537db Mon Sep 17 00:00:00 2001
From: jason plumb <75337021+breedx-splk@users.noreply.github.com>
Date: Thu, 11 Aug 2022 12:53:35 -0700
Subject: [PATCH] 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
---
 .github/workflows/pr.yaml | 8 ++++++++
 .lycheeignore             | 4 ++++
 README.md                 | 2 +-
 3 files changed, 13 insertions(+), 1 deletion(-)
 create mode 100644 .lycheeignore

diff --git a/.github/workflows/pr.yaml b/.github/workflows/pr.yaml
index 058317ed7..cc51d5603 100644
--- a/.github/workflows/pr.yaml
+++ b/.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/lychee-action@v1.5.1
+        with:
+          fail: true
diff --git a/.lycheeignore b/.lycheeignore
new file mode 100644
index 000000000..bb28bb18c
--- /dev/null
+++ b/.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
\ No newline at end of file
diff --git a/README.md b/README.md
index 5ba033e0a..d5a948d8e 100644
--- a/README.md
+++ b/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.