a99e168201
Bumps [ruby/setup-ruby](https://github.com/ruby/setup-ruby) from 1.174.0 to 1.175.0.
- [Release notes](https://github.com/ruby/setup-ruby/releases)
- [Commits](6bd3d993c6...70da3bbf44)
---
updated-dependencies:
- dependency-name: ruby/setup-ruby
dependency-type: direct:production
update-type: version-update:semver-minor
...
Signed-off-by: dependabot[bot] <support@github.com>
81 lines
2.3 KiB
YAML
81 lines
2.3 KiB
YAML
name: Documentation CI
|
|
|
|
on:
|
|
push:
|
|
branches:
|
|
- master
|
|
pull_request:
|
|
|
|
permissions:
|
|
contents: read
|
|
|
|
jobs:
|
|
linting:
|
|
if: github.repository == 'Homebrew/brew'
|
|
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: Install vale
|
|
run: brew install vale
|
|
|
|
- name: Run vale for docs linting
|
|
working-directory: ${{ steps.set-up-homebrew.outputs.repository-path }}/docs
|
|
run: vale .
|
|
|
|
- name: Install Ruby
|
|
uses: ruby/setup-ruby@70da3bbf44ac06db1b0547ce2acc9380a5270d1e # v1.175.0
|
|
with:
|
|
ruby-version: "3.1"
|
|
bundler-cache: true
|
|
working-directory: ${{ steps.set-up-homebrew.outputs.repository-path }}/docs
|
|
|
|
- name: Check Markdown syntax
|
|
working-directory: ${{ steps.set-up-homebrew.outputs.repository-path }}/docs
|
|
run: bundle exec rake lint
|
|
|
|
- name: Check code blocks conform to our Ruby style guide
|
|
working-directory: ${{ steps.set-up-homebrew.outputs.repository-path }}/docs
|
|
run: brew style .
|
|
|
|
- name: Build the site and check for broken links
|
|
working-directory: ${{ steps.set-up-homebrew.outputs.repository-path }}/docs
|
|
run: |
|
|
bundle exec rake test
|
|
|
|
rubydoc:
|
|
if: github.repository == 'Homebrew/brew'
|
|
runs-on: ubuntu-22.04
|
|
env:
|
|
BUNDLE_GEMFILE: ${{ github.workspace }}/rubydoc/Gemfile
|
|
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 Homebrew/rubydoc.brew.sh
|
|
uses: actions/checkout@v4
|
|
with:
|
|
repository: Homebrew/rubydoc.brew.sh
|
|
path: rubydoc
|
|
|
|
- name: Install Ruby
|
|
uses: ruby/setup-ruby@70da3bbf44ac06db1b0547ce2acc9380a5270d1e # v1.175.0
|
|
with:
|
|
ruby-version: "3.1"
|
|
bundler-cache: true
|
|
|
|
- name: Process rubydoc comments
|
|
working-directory: ${{ steps.set-up-homebrew.outputs.repository-path }}/Library/Homebrew
|
|
run: bundle exec yard doc --no-output --fail-on-warning
|