dbt-docs/Taskfile.yml at main · datnguye/dbt-docs · 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
65
66
67
68
69
70
71
72
73
74
75
version: "3"

silent: true

tasks:
  default:
    desc: List available tasks.
    cmds:
      - task --list

  install:
    desc: Sync the uv environment (incl. dev group).
    cmds:
      - uv sync --group dev

  frontend:install:
    desc: Install the React Flow graph app's npm deps (frontend/).
    cmds:
      - npm --prefix frontend ci

  frontend:build:
    desc: Build the React Flow graph bundle into the SPA (commit the output).
    cmds:
      - npm --prefix frontend run build

  frontend:test:
    desc: Run the graph app's vitest unit tests.
    cmds:
      - npm --prefix frontend test

  frontend:e2e:install:
    desc: Install the Playwright browser (chromium) for the E2E suite.
    cmds:
      - npm --prefix frontend run e2e:install

  frontend:e2e:
    desc: Run the Playwright E2E tests against a real demo build (kept out of the coverage gate).
    cmds:
      - npm --prefix frontend run e2e

  format:
    desc: Apply Ruff formatting and autofixes.
    cmds:
      - uv run ruff format .
      - uv run ruff check --fix .

  lint:
    desc: Ruff format-check and lint (no writes).
    cmds:
      - uv run ruff format --check .
      - uv run ruff check .

  test:
    desc: Pytest with the 100% coverage gate.
    cmds:
      - uv run pytest --cov=dbdocs --cov-report=term-missing --cov-fail-under=100

  demo:docs:
    desc: 'Build the demo and serve the mkdocs site with it embedded (open http://127.0.0.1:8000/demo/latest/).'
    cmds:
      - uv run dbdocs -c docs/dbdocs-demo.yml deploy --version 1.0 --alias latest
      - uv run mkdocs serve

  git-hooks:
    desc: Install pre-commit and commit-msg git hooks.
    cmds:
      - uv run pre-commit install --install-hooks
      - uv run pre-commit install --hook-type commit-msg

  clean:
    desc: Remove generated artefacts and caches (leaves .venv + node_modules intact).
    cmds:
      - rm -rf target site dist
      - rm -rf .pytest_cache .ruff_cache .coverage coverage.xml
      - rm -rf frontend/.vite frontend/coverage