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.
This commit is contained in:
Mike McQuaid 2025-06-27 08:09:24 +01:00
parent 415c0de6b2
commit e3e8ccef0a
No known key found for this signature in database
2 changed files with 9 additions and 1 deletions

View File

@ -69,6 +69,12 @@ jobs:
working-directory: docs working-directory: docs
run: ../script/generate-api-samples.rb --template 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 - name: Build the site and check for broken links
working-directory: docs working-directory: docs
run: bundle exec rake test run: bundle exec rake test

View File

@ -38,10 +38,12 @@ task test: :build do
%r{https://github.com/}, %r{https://github.com/},
%r{https://homebrew.1password.com/}, %r{https://homebrew.1password.com/},
"https://legacy.python.org/dev/peps/pep-0453/#recommendations-for-downstream-distributors", "https://legacy.python.org/dev/peps/pep-0453/#recommendations-for-downstream-distributors",
"https://metacpan.org/pod/local::lib",
], ],
cache: { cache: {
timeframe: { timeframe: {
external: "1h", external: "1d",
internal: "1h",
}, },
}, },
).run ).run