Warn about undocumented non-private APIs. #8379
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 | |
| 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: Lint docs | |
| working-directory: ${{ steps.set-up-homebrew.outputs.repository-path }} | |
| run: | | |
| set -euo 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 | |
| vale . | |
| # Restore removed files. | |
| git reset --hard | |
| - name: Install Ruby | |
| uses: ruby/setup-ruby@1198b074305f9356bd56dd4b311757cc0dab2f1c # v1.175.1 | |
| 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@1198b074305f9356bd56dd4b311757cc0dab2f1c # v1.175.1 | |
| 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 |