From 101229d3f4dad608947a41d41b01dd265bf1bcf2 Mon Sep 17 00:00:00 2001 From: "a.tolmachev" Date: Sun, 3 May 2026 19:43:09 +0000 Subject: [PATCH] docs: align community release path --- .github/workflows/ci.yml | 4 ++-- README.md | 4 ++-- TASKS.md | 1 + docs/authenticated-staging-pass.md | 1 + docs/deploy-and-staging-smoke.md | 6 ++++++ docs/runtime-config.md | 5 +++-- 6 files changed, 15 insertions(+), 6 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 3eb526a..4742b47 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -133,5 +133,5 @@ jobs: - name: Checkout uses: actions/checkout@v5 - - name: Validate docker compose - run: docker compose config -q + - name: Validate Community deployment manifest + run: docker compose -f deploy/community/docker-compose.yml --env-file deploy/community/.env.example config -q diff --git a/README.md b/README.md index 9407cf4..8d014e4 100644 --- a/README.md +++ b/README.md @@ -93,8 +93,8 @@ Crank - платформа для публикации внешних API в в В репозитории настроены: - `CI` для Rust, UI и deployment manifests; -- `CD`, который после успешного `CI` на `main` собирает versioned images, пушит их в `GHCR` и деплоит через `docker compose pull`; -- containerized deployment через `docker compose`. +- `CD`, который после успешного `CI` на `main` собирает versioned images, пушит их в `GHCR` и деплоит Community через `deploy/community/docker-compose.yml`; +- containerized Community deployment через `deploy/community/docker-compose.yml`. ## Поддерживаемые протоколы diff --git a/TASKS.md b/TASKS.md index 8392fd0..76718b2 100644 --- a/TASKS.md +++ b/TASKS.md @@ -40,6 +40,7 @@ Progress: - done: - gate for creating `2` private repositories is already documented before any physical commercial split - canonical Community deployment manifest and env template now live under `deploy/community/*`, and public deploy uses that manifest instead of the root compose file + - CI, README, runtime/deploy smoke docs now point to `deploy/community/*` as the Community delivery source of truth - pending: - remaining extension seams and packaging split still need to move from planning into concrete public/private manifests diff --git a/docs/authenticated-staging-pass.md b/docs/authenticated-staging-pass.md index 0a36827..0f466b7 100644 --- a/docs/authenticated-staging-pass.md +++ b/docs/authenticated-staging-pass.md @@ -22,6 +22,7 @@ - свежий deploy уже прошел helper smoke: - `just staging-smoke https://` +- Community deploy был собран из `deploy/community/docker-compose.yml` - automated browser-authenticated smoke при необходимости запускается так: - `CRANK_STAGING_ADMIN_EMAIL=... CRANK_STAGING_ADMIN_PASSWORD=... just authenticated-staging-smoke https://` - известны bootstrap admin credentials; diff --git a/docs/deploy-and-staging-smoke.md b/docs/deploy-and-staging-smoke.md index 3253678..bb94efa 100644 --- a/docs/deploy-and-staging-smoke.md +++ b/docs/deploy-and-staging-smoke.md @@ -9,6 +9,11 @@ - быстро проверить, что свежий deploy реально жив, а не просто "docker compose up -d завершился"; - дать следующему агенту и оператору один канонический сценарий проверки после релиза. +Для Community-поставки source of truth для runtime manifests: + +- `deploy/community/docker-compose.yml` +- `deploy/community/.env.example` + Результаты прохождения этого checklist нужно заносить в [staging-regression-notes.md](/home/a.tolmachev/code/rust/mcpaas/docs/staging-regression-notes.md). Для полного browser-authenticated прохода использовать отдельный документ: @@ -34,6 +39,7 @@ - задеплоенный стек `ui`, `admin-api`, `mcp-server`, `postgres`; - корректный `.env` на сервере; - валидный deploy через `.github/workflows/deploy.yml`; +- server deployment path собран из public Community manifest, а не из ad-hoc compose файла; - включенный `CRANK_DEMO_SEED=true`, если нужен предзаполненный smoke state; - bootstrap admin credentials для входа в UI. diff --git a/docs/runtime-config.md b/docs/runtime-config.md index 7b3068c..727517a 100644 --- a/docs/runtime-config.md +++ b/docs/runtime-config.md @@ -224,8 +224,9 @@ runtime env-переменной. Это значит, что: Для production-like запуска проект должен поставляться с: - `Dockerfile` для backend приложений; -- `docker-compose.yml`; -- `.env.example`; +- `deploy/community/docker-compose.yml` как canonical Community deployment manifest; +- `deploy/community/.env.example` как canonical Community env template; +- root `docker-compose.yml` и root `.env.example` только как local development convenience files; - healthcheck endpoints; - reverse proxy configuration examples.