Files
claude-cookbooks/.github/workflows/notebook-quality.yml
Alex Notov d7db210bd4 fix: remove nbstripout and preserve notebook outputs
Notebook outputs are educational content in cookbook repositories.
They show users what to expect when running the code.

- Remove nbstripout from all dependencies and configurations
- Remove nbstripout check from CI workflow
- Update documentation to explain outputs are intentional
- Make validation scripts non-blocking for POC
- Fix lychee configuration conflict

The CI now validates notebooks without removing demonstration outputs.
2025-09-07 16:07:13 -06:00

93 lines
2.8 KiB
YAML

name: Notebook Quality Check
on:
pull_request:
paths:
- 'skills/**/*.ipynb'
- 'pyproject.toml'
- 'uv.lock'
push:
branches: [main]
paths:
- 'skills/**/*.ipynb'
permissions:
contents: read
jobs:
validate-notebooks:
runs-on: ubuntu-latest
strategy:
matrix:
python-version: ['3.11', '3.12']
steps:
- uses: actions/checkout@v4
- name: Install uv
uses: astral-sh/setup-uv@v4
with:
enable-cache: true
cache-dependency-glob: "uv.lock"
- name: Set up Python ${{ matrix.python-version }}
run: uv python install ${{ matrix.python-version }}
- name: Install dependencies
run: |
uv sync --frozen --all-extras
- name: Lint notebooks with Ruff
run: |
uv run ruff check skills/**/*.ipynb --show-fixes || true
uv run ruff format skills/**/*.ipynb --check || true
- name: Validate notebook structure
run: |
uv run python scripts/validate_notebooks.py
- name: Check model usage
run: |
uv run python scripts/check_models.py
# Only run API tests on main branch or for maintainers (costs money)
- name: Execute notebooks (API Testing)
if: |
github.event_name == 'push' ||
github.event.pull_request.author_association == 'MEMBER' ||
github.event.pull_request.author_association == 'OWNER'
env:
ANTHROPIC_API_KEY: ${{ secrets.ANTHROPIC_API_KEY }}
run: |
for notebook in skills/*/guide.ipynb; do
echo "📓 Testing: $notebook"
# Use nbconvert to execute notebooks
uv run jupyter nbconvert --to notebook \
--execute "$notebook" \
--ExecutePreprocessor.kernel_name=python3 \
--ExecutePreprocessor.timeout=120 \
--stdout > /dev/null \
|| echo "⚠️ Failed: $notebook"
done
# Mock testing for external contributors
- name: Execute notebooks (Mock Testing)
if: |
github.event_name == 'pull_request' &&
github.event.pull_request.author_association != 'MEMBER' &&
github.event.pull_request.author_association != 'OWNER'
run: |
echo "🔒 Running in mock mode for external contributor"
for notebook in skills/*/guide.ipynb; do
echo "📓 Validating structure: $notebook"
uv run python -m nbformat.validator.validate "$notebook"
done
- name: Upload test outputs
if: always()
uses: actions/upload-artifact@v4
with:
name: notebook-test-outputs-py${{ matrix.python-version }}
path: test_outputs/
retention-days: 7