From e3e8ccef0abb215f56b26710161b48824384e339 Mon Sep 17 00:00:00 2001
From: Mike McQuaid <mike@mikemcquaid.com>
Date: Fri, 27 Jun 2025 08:09:24 +0100
Subject: [PATCH] docs: fix HTML Proofer in CI

- Add caching to make this build faster and less flaky.
- Skip the currently flaky URL.
- Cache external links for longer.
---
 .github/workflows/docs.yml | 6 ++++++
 docs/Rakefile              | 4 +++-
 2 files changed, 9 insertions(+), 1 deletion(-)

diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
index debaaae995..dbac948702 100644
--- a/.github/workflows/docs.yml
+++ b/.github/workflows/docs.yml
@@ -69,6 +69,12 @@ jobs:
         working-directory: docs
         run: ../script/generate-api-samples.rb --template
 
+      - name: Cache HTML Proofer
+        uses: actions/cache@5a3ec84eff668545956fd18022155c47e93e2684 # v4.2.3
+        with:
+          path: tmp/.htmlproofer
+          key: ${{ runner.os }}-htmlproofer
+
       - name: Build the site and check for broken links
         working-directory: docs
         run: bundle exec rake test
diff --git a/docs/Rakefile b/docs/Rakefile
index 5411ccfa0a..dc07a35c13 100644
--- a/docs/Rakefile
+++ b/docs/Rakefile
@@ -38,10 +38,12 @@ task test: :build do
       %r{https://github.com/},
       %r{https://homebrew.1password.com/},
       "https://legacy.python.org/dev/peps/pep-0453/#recommendations-for-downstream-distributors",
+      "https://metacpan.org/pod/local::lib",
     ],
     cache:               {
       timeframe: {
-        external: "1h",
+        external: "1d",
+        internal: "1h",
       },
     },
   ).run