Complete 0.1.0 release implementation #4
Workflow file for this run
This file contains hidden or 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 Quality Check | |
| on: | |
| push: | |
| branches: [ main, develop ] | |
| pull_request: | |
| branches: [ main, develop ] | |
| # Allow manual triggering | |
| workflow_dispatch: | |
| jobs: | |
| vale-linting: | |
| name: Vale Documentation Linting | |
| runs-on: ubuntu-latest | |
| timeout-minutes: 10 | |
| steps: | |
| - name: Checkout code | |
| uses: actions/checkout@v4 | |
| - name: Setup Vale | |
| uses: errata-ai/vale-action@reviewdog | |
| with: | |
| # Version of Vale to use | |
| version: '3.12.0' | |
| # Files to lint (supports glob patterns) | |
| files: '["*.adoc", "docs/**/*.adoc", "specs/tests/*.adoc"]' | |
| # Upload results as annotations | |
| reporter: github-pr-review | |
| # Don't fail on warnings, only on errors | |
| level: error | |
| fail_on_error: false | |
| env: | |
| # Required for PR comments | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| documentation-tests: | |
| name: Documentation Build Test | |
| runs-on: ubuntu-latest | |
| timeout-minutes: 10 | |
| steps: | |
| - name: Checkout code | |
| uses: actions/checkout@v4 | |
| - name: Setup Ruby | |
| uses: ruby/setup-ruby@v1 | |
| with: | |
| ruby-version: '3.1' | |
| bundler-cache: true | |
| - name: Install Vale | |
| run: | | |
| wget -O vale.tar.gz https://github.com/errata-ai/vale/releases/download/v3.12.0/vale_3.12.0_Linux_64-bit.tar.gz | |
| tar -xzf vale.tar.gz | |
| sudo mv vale /usr/local/bin/ | |
| vale --version | |
| - name: Setup Vale styles | |
| run: | | |
| vale sync | |
| - name: Run documentation quality checks | |
| run: | | |
| bundle exec rake quality | |
| - name: Test documentation examples | |
| run: | | |
| # Test any code examples in documentation | |
| if [ -d "lib/examples" ]; then | |
| echo "Testing documentation examples..." | |
| for file in lib/examples/*.yml; do | |
| if [ -f "$file" ]; then | |
| echo "Validating $file" | |
| ruby -e "require 'yaml'; YAML.load_file('$file')" || exit 1 | |
| fi | |
| done | |
| fi |