feat(code-review): declare codebase bundle peer dependency (0.46.0) #101
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
| # yaml-language-server: $schema=https://json.schemastore.org/github-workflow.json | |
| # yamllint disable rule:line-length rule:truthy | |
| name: Docs Review | |
| on: | |
| pull_request: | |
| branches: [main, dev] | |
| paths: | |
| - "**/*.md" | |
| - "**/*.mdc" | |
| - "docs/**" | |
| - "scripts/check-docs-commands.py" | |
| - "tests/unit/test_check_docs_commands_script.py" | |
| - "tests/unit/docs/test_docs_review.py" | |
| - ".github/workflows/docs-review.yml" | |
| push: | |
| branches: [main, dev] | |
| paths: | |
| - "**/*.md" | |
| - "**/*.mdc" | |
| - "docs/**" | |
| - "scripts/check-docs-commands.py" | |
| - "tests/unit/test_check_docs_commands_script.py" | |
| - "tests/unit/docs/test_docs_review.py" | |
| - ".github/workflows/docs-review.yml" | |
| workflow_dispatch: | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }} | |
| cancel-in-progress: true | |
| permissions: | |
| contents: read | |
| jobs: | |
| docs-review: | |
| name: Docs Review | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Set up Python 3.12 | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: "3.12" | |
| cache: "pip" | |
| - name: Install docs review dependencies | |
| run: | | |
| python -m pip install --upgrade pip | |
| python -m pip install pytest click typer PyYAML beartype icontract rich pydantic specfact-cli | |
| - name: Run docs review suite | |
| run: | | |
| mkdir -p logs/docs-review | |
| DOCS_REVIEW_LOG="logs/docs-review/docs-review_$(date -u +%Y%m%d_%H%M%S).log" | |
| python -m pytest tests/unit/docs/test_docs_review.py -q 2>&1 | tee "$DOCS_REVIEW_LOG" | |
| exit "${PIPESTATUS[0]:-$?}" | |
| - name: Validate docs commands and cross-site links | |
| run: | | |
| mkdir -p logs/docs-review | |
| DOCS_COMMAND_LOG="logs/docs-review/docs-command-validation_$(date -u +%Y%m%d_%H%M%S).log" | |
| python scripts/check-docs-commands.py 2>&1 | tee "$DOCS_COMMAND_LOG" | |
| exit "${PIPESTATUS[0]:-$?}" | |
| - name: Upload docs review logs | |
| if: always() | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: docs-review-logs | |
| path: logs/docs-review/ | |
| if-no-files-found: ignore |