docs: align community release path

This commit is contained in:
a.tolmachev
2026-05-03 19:43:09 +00:00
parent 1661b2b4d0
commit 101229d3f4
6 changed files with 15 additions and 6 deletions
+2 -2
View File
@@ -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
+2 -2
View File
@@ -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`.
## Поддерживаемые протоколы
+1
View File
@@ -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
+1
View File
@@ -22,6 +22,7 @@
- свежий deploy уже прошел helper smoke:
- `just staging-smoke https://<domain>`
- Community deploy был собран из `deploy/community/docker-compose.yml`
- automated browser-authenticated smoke при необходимости запускается так:
- `CRANK_STAGING_ADMIN_EMAIL=... CRANK_STAGING_ADMIN_PASSWORD=... just authenticated-staging-smoke https://<domain>`
- известны bootstrap admin credentials;
+6
View File
@@ -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.
+3 -2
View File
@@ -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.