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

docs: more workflow improvements. #17470

Merged
merged 1 commit into from
Jun 11, 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
5 changes: 5 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,11 @@ jobs:
- name: Check code blocks conform to our Ruby style guide
run: brew style docs

- name: Generate formulae.brew.sh API samples
if: github.repository == 'Homebrew/formulae.brew.sh'
working-directory: docs
run: ../script/generate-api-samples.rb

- name: Build the site and check for broken links
working-directory: docs
run: bundle exec rake test
Expand Down
31 changes: 16 additions & 15 deletions docs/Rakefile
Original file line number Diff line number Diff line change
Expand Up @@ -17,26 +17,27 @@ task test: :build do
require "html-proofer"
HTMLProofer.check_directory(
"./_site",
parallel: { in_threads: 4 },
favicon: true,
parallel: { in_threads: 4 },
favicon: true,
ignore_status_codes: [0, 403],
check_favicon: true,
check_opengraph: true,
check_html: true,
check_img_http: true,
enforce_https: true,
ignore_files: [
%r{Kickstarter-Supporters},
check_favicon: true,
check_opengraph: true,
check_html: true,
check_img_http: true,
enforce_https: true,
ignore_files: [
/Kickstarter-Supporters/,
],
ignore_urls: [
ignore_urls: [
"/",
%r{https://formulae.brew.sh"},
%r{https://github.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",
],
cache: {
cache: {
timeframe: {
external: "1h"
}
}
external: "1h",
},
},
).run
end