docs(#1): SDK integration guide, API reference, and CI pipeline
All checks were successful
ci/woodpecker/push/woodpecker Pipeline was successful
All checks were successful
ci/woodpecker/push/woodpecker Pipeline was successful
- Rewrite README with quick start, FastAPI snippet, async/sync patterns, config reference with env vars, and API version targeting (v1, schema 1.0) - Add docs/integration-guide.md with full FastAPI and generic Python integration examples, environment-specific config, prediction queries, error handling, and dry-run mode documentation - Add docs/api-reference.md covering all exported classes, methods, Pydantic models, enums (TaskType, Complexity, Harness, Provider, QualityGate, Outcome, RepoSizeCategory), and internal components - Add Woodpecker CI pipeline (.woodpecker.yml) with quality gates: lint, format check, typecheck, bandit security scan, pip-audit, and pytest with 85% coverage gate - Add bandit and pip-audit to dev dependencies Fixes #1 Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
57
.woodpecker.yml
Normal file
57
.woodpecker.yml
Normal file
@@ -0,0 +1,57 @@
|
||||
when:
|
||||
- event: [push, pull_request, manual]
|
||||
|
||||
variables:
|
||||
- &uv_image "ghcr.io/astral-sh/uv:python3.12-bookworm-slim"
|
||||
|
||||
steps:
|
||||
install:
|
||||
image: *uv_image
|
||||
commands:
|
||||
- uv sync --all-extras --frozen
|
||||
|
||||
lint:
|
||||
image: *uv_image
|
||||
commands:
|
||||
- |
|
||||
uv sync --all-extras --frozen
|
||||
uv run ruff check src/ tests/
|
||||
uv run ruff format --check src/ tests/
|
||||
depends_on:
|
||||
- install
|
||||
|
||||
typecheck:
|
||||
image: *uv_image
|
||||
commands:
|
||||
- |
|
||||
uv sync --all-extras --frozen
|
||||
uv run mypy src/
|
||||
depends_on:
|
||||
- install
|
||||
|
||||
security-bandit:
|
||||
image: *uv_image
|
||||
commands:
|
||||
- |
|
||||
uv sync --all-extras --frozen
|
||||
uv run bandit -r src/ -f screen --skip B311
|
||||
depends_on:
|
||||
- install
|
||||
|
||||
security-audit:
|
||||
image: *uv_image
|
||||
commands:
|
||||
- |
|
||||
uv sync --all-extras --frozen
|
||||
uv run pip-audit
|
||||
depends_on:
|
||||
- install
|
||||
|
||||
test:
|
||||
image: *uv_image
|
||||
commands:
|
||||
- |
|
||||
uv sync --all-extras --frozen
|
||||
uv run pytest --cov=src/mosaicstack_telemetry --cov-report=term-missing --cov-fail-under=85
|
||||
depends_on:
|
||||
- install
|
||||
Reference in New Issue
Block a user