mirror of
https://github.com/Homebrew/brew.git
synced 2025-07-14 16:09:03 +08:00
a707c708c1
- start running this check again - check the `docs` basename correctly - use a different name (to a symlink) for the docs rubocop configuration so that path relativity is done correctly: https://docs.rubocop.org/rubocop/configuration.html#path-relativity - add more wildcards to fix docs rubocop exclusions
76 lines
1.8 KiB
YAML
76 lines
1.8 KiB
YAML
name: Documentation CI
|
|
|
|
on:
|
|
push:
|
|
branches:
|
|
- master
|
|
pull_request:
|
|
|
|
permissions:
|
|
contents: read
|
|
pages: read
|
|
|
|
env:
|
|
HOMEBREW_DEVELOPER: 1
|
|
HOMEBREW_NO_AUTO_UPDATE: 1
|
|
HOMEBREW_NO_ENV_HINTS: 1
|
|
HOMEBREW_BOOTSNAP: 1
|
|
HOMEBREW_NO_INSTALL_CLEANUP: 1
|
|
|
|
jobs:
|
|
docs:
|
|
runs-on: ubuntu-22.04
|
|
steps:
|
|
- name: Set up Homebrew
|
|
id: set-up-homebrew
|
|
uses: Homebrew/actions/setup-homebrew@master
|
|
with:
|
|
core: false
|
|
cask: false
|
|
test-bot: false
|
|
|
|
- name: Checkout repository
|
|
uses: actions/checkout@v4
|
|
|
|
- name: Install vale
|
|
run: brew install vale
|
|
|
|
- name: Cleanup Homebrew/brew docs
|
|
if: github.repository == 'Homebrew/brew'
|
|
run: |
|
|
set -xeuo pipefail
|
|
|
|
# Avoid failing on broken symlinks.
|
|
rm Library/Homebrew/os/mac/pkgconfig/fuse/fuse.pc
|
|
rm Library/Homebrew/os/mac/pkgconfig/fuse/osxfuse.pc
|
|
|
|
# No ignore support (https://github.com/errata-ai/vale/issues/131).
|
|
rm -r Library/Homebrew/vendor
|
|
|
|
- name: Run Vale
|
|
run: vale docs/
|
|
|
|
- name: Install Ruby
|
|
uses: ruby/setup-ruby@ff740bc00a01b3a50fffc55a1071b1060eeae9dc # v1.180.0
|
|
with:
|
|
bundler-cache: true
|
|
working-directory: docs
|
|
|
|
- name: Check Markdown syntax
|
|
working-directory: docs
|
|
run: bundle exec rake lint
|
|
|
|
- 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
|
|
env:
|
|
JEKYLL_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|