docs: sync documentation with latest changes (168 tests, metrics, Makefile, pre-commit)

This commit is contained in:
Marker689
2026-05-11 23:21:11 +03:00
parent 5c8cbabefd
commit 6ea5c85a4b
3 changed files with 71 additions and 9 deletions

View File

@@ -188,7 +188,7 @@ curl -X POST http://localhost:8080/webhooks/nexus \
|-------|------|----------|
| GET | `/health` | Проверка работоспособности |
| GET | `/health/dependencies` | Проверка БД и доступности Nexus API |
| GET | `/metrics` | Метрики в формате Prometheus |
| GET | `/metrics` | Prometheus-метрики: `guarddog_scans_total`, `guarddog_scans_flagged_total`, `guarddog_findings_total`, `guarddog_llm_analyzed_total`, `guarddog_llm_pending_total`, `guarddog_scans_by_status`, `guarddog_scans_by_ecosystem`, `guarddog_last_scan_timestamp_seconds` |
## Веб-интерфейс
@@ -240,15 +240,22 @@ guarddog-nexus/
|---------|----------|
| `make install` | Установка зависимостей проекта |
| `make dev` | Установка зависимостей для разработки |
| `make test` | Запуск тестов |
| `make test` | Запуск тестов (168) |
| `make lint` | Проверка кода через Ruff |
| `make format` | Форматирование кода через Ruff |
| `make typecheck` | Проверка типов через mypy (strict mode) |
| `make check` | lint + format + typecheck + test (все проверки) |
| `make run` | Запуск приложения локально |
| `make setup-env` | Копирование `.env.example``.env` (если отсутствует) |
| `make docker-build` | Сборка Docker-образа |
| `make docker-up` | Пересборка и запуск стека (`up -d --build`) |
| `make docker-down` | Остановка стека |
| `make docker-destroy` | Остановка стека с удалением всех данных (`-v`) |
| `make docker-logs` | Просмотр логов стека |
| `make docker-rebuild` | Полная пересборка (down + build + up) |
| `make docker-ps` | Статус контейнеров (`docker compose ps`) |
| `make docker-shell` | Интерактивная оболочка в контейнере |
| `make docker-restart` | Перезапуск контейнера guarddog-nexus |
| `make clean` | Очистка артефактов сборки |
## Безопасность