c8213558ef
Bumps the github-actions group with 3 updates: [github/codeql-action](https://github.com/github/codeql-action), [ruby/setup-ruby](https://github.com/ruby/setup-ruby) and [actions/attest-build-provenance](https://github.com/actions/attest-build-provenance). Updates `github/codeql-action` from 3.28.19 to 3.29.0 - [Release notes](https://github.com/github/codeql-action/releases) - [Changelog](https://github.com/github/codeql-action/blob/main/CHANGELOG.md) - [Commits](fca7ace96b...ce28f5bb42) Updates `ruby/setup-ruby` from 1.244.0 to 1.245.0 - [Release notes](https://github.com/ruby/setup-ruby/releases) - [Changelog](https://github.com/ruby/setup-ruby/blob/master/release.rb) - [Commits](13e7a03dc3...a4effe49ee) Updates `actions/attest-build-provenance` from 2.3.0 to 2.4.0 - [Release notes](https://github.com/actions/attest-build-provenance/releases) - [Changelog](https://github.com/actions/attest-build-provenance/blob/main/RELEASE.md) - [Commits](db473fddc0...e8998f9491) --- updated-dependencies: - dependency-name: github/codeql-action dependency-version: 3.29.0 dependency-type: direct:production update-type: version-update:semver-minor dependency-group: github-actions - dependency-name: ruby/setup-ruby dependency-version: 1.245.0 dependency-type: direct:production update-type: version-update:semver-minor dependency-group: github-actions - dependency-name: actions/attest-build-provenance dependency-version: 2.4.0 dependency-type: direct:production update-type: version-update:semver-minor dependency-group: github-actions ... Signed-off-by: dependabot[bot] <support@github.com>
77 lines
1.9 KiB
YAML
77 lines
1.9 KiB
YAML
name: Documentation CI
|
|
|
|
on:
|
|
pull_request:
|
|
merge_group:
|
|
|
|
permissions:
|
|
contents: read
|
|
pages: read
|
|
|
|
env:
|
|
HOMEBREW_DEVELOPER: 1
|
|
HOMEBREW_NO_AUTO_UPDATE: 1
|
|
HOMEBREW_NO_ENV_HINTS: 1
|
|
HOMEBREW_NO_INSTALL_CLEANUP: 1
|
|
|
|
defaults:
|
|
run:
|
|
shell: bash -xeuo pipefail {0}
|
|
|
|
jobs:
|
|
docs:
|
|
runs-on: ubuntu-latest
|
|
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@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
|
|
with:
|
|
persist-credentials: false
|
|
|
|
- name: Install vale
|
|
run: brew install vale
|
|
|
|
- name: Cleanup Homebrew/brew docs
|
|
if: github.repository == 'Homebrew/brew'
|
|
run: |
|
|
# 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@a4effe49ee8ee5b8b5091268c473a4628afb5651 # v1.245.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 --template
|
|
|
|
- name: Build the site and check for broken links
|
|
working-directory: docs
|
|
run: bundle exec rake test
|
|
env:
|
|
JEKYLL_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|