Merge pull request #15969 from glensc/patch-1 #4
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 | |
| 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@v1 | |
| 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: 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@main | |
| with: | |
| repository: Homebrew/rubydoc.brew.sh | |
| path: rubydoc | |
| - name: Install Ruby | |
| uses: ruby/setup-ruby@v1 | |
| with: | |
| ruby-version: "2.7" | |
| 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 |