build(deps): bump github/codeql-action from 319cdb9fa619417d07cc37a964f0502bfbc5e8a9 to 4fa2a7953630fd2f3fb380f21be14ede0169dd4f #9759
Workflow file for this run
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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@692973e3d937129bcbf40652eb9f2f61becf3332 # 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@161cd54b698f1fb3ea539faab2e036d409550e3c # v1.187.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 }} |