documentation-generator/.github/workflows/ci.yml at main · jmjava/documentation-generator · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
name: CI

on:
  push:
    branches: [main]
  pull_request:
    branches: [main]

concurrency:
  group: ci-${{ github.ref }}
  cancel-in-progress: true

jobs:
  lint:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v6
      - uses: actions/setup-python@v6
        with:
          python-version: "3.12"
      - run: pip install ruff
      - run: ruff check src/ tests/

  unit:
    runs-on: ubuntu-latest
    strategy:
      matrix:
        python-version: ["3.10", "3.11", "3.12"]
    steps:
      - uses: actions/checkout@v6
      - uses: actions/setup-python@v6
        with:
          python-version: ${{ matrix.python-version }}
      - name: Install system dependencies
        run: sudo apt-get update && sudo apt-get install -y --no-install-recommends ffmpeg tesseract-ocr
      - run: pip install ".[dev]"
      - run: pytest tests/ --ignore=tests/e2e -v --tb=short

  smoke:
    name: smoke (config + lint + tts dry-run)
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v6
      - uses: actions/setup-python@v6
        with:
          python-version: "3.12"
      - run: pip install .
      - name: Validate config loads
        run: docgen --config docs/demos/docgen.yaml validate --help
      - name: Narration lint
        run: docgen --config docs/demos/docgen.yaml lint
      - name: TTS dry-run
        run: docgen --config docs/demos/docgen.yaml tts --dry-run

  e2e:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v6
      - uses: actions/setup-python@v6
        with:
          python-version: "3.12"
      - run: pip install ".[dev]"
      - run: playwright install --with-deps chromium
      - run: pytest tests/e2e/ -v --tb=short