diff --git a/docs/uk/ci.md b/docs/uk/ci.md index 79728cc6f..654b40ded 100644 --- a/docs/uk/ci.md +++ b/docs/uk/ci.md @@ -1,81 +1,82 @@ --- read_when: - - Вам потрібно зрозуміти, чому завдання CI було або не було запущене + - Вам потрібно зрозуміти, чому завдання CI запустилося або не запустилося - Ви налагоджуєте збої перевірок GitHub Actions -summary: Граф завдань CI, обмеження області дії та локальні еквіваленти команд +summary: Граф завдань CI, обмеження за областями та локальні еквіваленти команд title: Конвеєр CI x-i18n: - generated_at: "2026-04-23T00:59:01Z" + generated_at: "2026-04-23T01:39:42Z" model: gpt-5.4 provider: openai - source_hash: 4d19801199a102291045bf2b2f7d9a66495c23785a1e89a953af8969e52fc0cb + source_hash: f50aec8600006363b3e84184d6ccafcfdcc2e68c5a078013795336972412b7b4 source_path: ci.md workflow: 15 --- # Конвеєр CI -CI запускається при кожному пуші в `main` і для кожного pull request. Він використовує розумне обмеження області дії, щоб пропускати дорогі завдання, коли змінилися лише не пов’язані ділянки. +CI запускається для кожного push до `main` і для кожного pull request. Він використовує розумне обмеження за областями, щоб пропускати дорогі завдання, коли змінено лише не пов’язані ділянки. ## Огляд завдань -| Завдання | Призначення | Коли запускається | -| --------------------------------- | ------------------------------------------------------------------------------------------ | ------------------------------------ | -| `preflight` | Виявлення змін лише в документації, змінених областей, змінених розширень і побудова маніфесту CI | Завжди для нечернеткових пушів і PR | -| `security-scm-fast` | Виявлення приватних ключів і аудит workflow через `zizmor` | Завжди для нечернеткових пушів і PR | -| `security-dependency-audit` | Аудит production lockfile без залежностей на відповідність попередженням npm | Завжди для нечернеткових пушів і PR | -| `security-fast` | Обов’язковий агрегат для швидких завдань безпеки | Завжди для нечернеткових пушів і PR | -| `build-artifacts` | Збірка `dist/` і Control UI один раз, завантаження повторно використовуваних артефактів для наступних завдань | Зміни, що стосуються Node | -| `checks-fast-core` | Швидкі Linux-етапи перевірки коректності, такі як bundled/plugin-contract/protocol checks | Зміни, що стосуються Node | -| `checks-fast-contracts-channels` | Шардовані перевірки контрактів каналів зі стабільним агрегованим результатом перевірки | Зміни, що стосуються Node | -| `checks-node-extensions` | Повні шарди тестів bundled-plugin для всього набору розширень | Зміни, що стосуються Node | -| `checks-node-core-test` | Шарди основних Node-тестів, за винятком етапів каналів, bundled, contract і extension | Зміни, що стосуються Node | -| `extension-fast` | Цільові тести лише для змінених bundled plugins | Pull request із змінами в розширеннях | -| `check` | Шардований еквівалент основного локального gate: production types, lint, guards, test types і strict smoke | Зміни, що стосуються Node | -| `check-additional` | Шарди архітектурних перевірок, перевірок меж, extension-surface guards, package-boundary і gateway-watch | Зміни, що стосуються Node | -| `build-smoke` | Smoke-тести зібраного CLI і smoke перевірка пам’яті під час запуску | Зміни, що стосуються Node | -| `checks` | Решта Linux Node-етапів: тести каналів і сумісність Node 22 лише для push | Зміни, що стосуються Node | -| `check-docs` | Перевірки форматування документації, lint і перевірка битих посилань | Змінено документацію | -| `skills-python` | Ruff + pytest для Skills на Python | Зміни, що стосуються Python Skills | -| `checks-windows` | Windows-специфічні етапи тестування | Зміни, що стосуються Windows | -| `macos-node` | Етап тестів TypeScript на macOS із використанням спільних зібраних артефактів | Зміни, що стосуються macOS | -| `macos-swift` | Swift lint, збірка і тести для застосунку macOS | Зміни, що стосуються macOS | -| `android` | Матриця збірки і тестів Android | Зміни, що стосуються Android | +| Завдання | Призначення | Коли запускається | +| -------------------------------- | -------------------------------------------------------------------------------------------- | ----------------------------------- | +| `preflight` | Визначає зміни лише в документації, змінені області, змінені extensions і будує маніфест CI | Завжди для non-draft push і PR | +| `security-scm-fast` | Виявлення приватних ключів і аудит workflow через `zizmor` | Завжди для non-draft push і PR | +| `security-dependency-audit` | Аудит production lockfile без залежностей щодо advisories npm | Завжди для non-draft push і PR | +| `security-fast` | Обов’язковий агрегатор для швидких завдань безпеки | Завжди для non-draft push і PR | +| `build-artifacts` | Один раз збирає `dist/` і Control UI, завантажує повторно використовувані артефакти для наступних завдань | Зміни, релевантні для Node | +| `checks-fast-core` | Швидкі Linux-етапи коректності, такі як bundled/plugin-contract/protocol перевірки | Зміни, релевантні для Node | +| `checks-fast-contracts-channels` | Шардовані перевірки контрактів channel із стабільним агрегованим результатом перевірки | Зміни, релевантні для Node | +| `checks-node-extensions` | Повні шардовані тести bundled-plugin для всього набору extensions | Зміни, релевантні для Node | +| `checks-node-core-test` | Шардовані core Node тести, без channel, bundled, contract та extension етапів | Зміни, релевантні для Node | +| `extension-fast` | Точкові тести лише для змінених bundled plugins | Pull request-и зі змінами extensions | +| `check` | Шардований еквівалент основного локального gate: prod типи, lint, guards, test types і strict smoke | Зміни, релевантні для Node | +| `check-additional` | Architecture, boundary, extension-surface guards, package-boundary і gateway-watch шарди | Зміни, релевантні для Node | +| `build-smoke` | Smoke-тести зібраного CLI і smoke перевірка пам’яті під час запуску | Зміни, релевантні для Node | +| `checks` | Решта Linux Node етапів: channel тести і лише для push сумісність Node 22 | Зміни, релевантні для Node | +| `check-docs` | Форматування документації, lint і перевірки битих посилань | Документацію змінено | +| `skills-python` | Ruff + pytest для Skills на базі Python | Зміни, релевантні для Python Skills | +| `checks-windows` | Етапи тестування, специфічні для Windows | Зміни, релевантні для Windows | +| `macos-node` | Етап тестів TypeScript на macOS із використанням спільних зібраних артефактів | Зміни, релевантні для macOS | +| `macos-swift` | Swift lint, збірка і тести для застосунку macOS | Зміни, релевантні для macOS | +| `android` | Android unit-тести для обох flavor плюс одна збірка debug APK | Зміни, релевантні для Android | -## Порядок fail-fast +## Порядок швидкого завершення з помилкою -Завдання впорядковані так, щоб дешеві перевірки завершувалися з помилкою раніше, ніж запустяться дорогі: +Завдання впорядковані так, щоб дешеві перевірки завершувалися з помилкою раніше, ніж запускатимуться дорогі: -1. `preflight` визначає, які етапи взагалі існують. Логіка `docs-scope` і `changed-scope` — це кроки всередині цього завдання, а не окремі завдання. -2. `security-scm-fast`, `security-dependency-audit`, `security-fast`, `check`, `check-additional`, `check-docs` і `skills-python` швидко завершуються з помилкою, не чекаючи важчих артефактних і платформних матричних завдань. -3. `build-artifacts` виконується паралельно зі швидкими Linux-етапами, щоб наступні споживачі могли стартувати, щойно буде готова спільна збірка. -4. Після цього розгалужуються важчі платформні та runtime-етапи: `checks-fast-core`, `checks-fast-contracts-channels`, `checks-node-extensions`, `checks-node-core-test`, лише для PR `extension-fast`, `checks`, `checks-windows`, `macos-node`, `macos-swift` і `android`. +1. `preflight` вирішує, які етапи взагалі існують. Логіка `docs-scope` і `changed-scope` — це кроки всередині цього завдання, а не окремі завдання. +2. `security-scm-fast`, `security-dependency-audit`, `security-fast`, `check`, `check-additional`, `check-docs` і `skills-python` завершуються з помилкою швидко, не чекаючи важчих матричних завдань артефактів і платформ. +3. `build-artifacts` виконується паралельно зі швидкими Linux-етапами, щоб наступні споживачі могли стартувати щойно спільна збірка буде готова. +4. Після цього розгалужуються важчі платформені та runtime-етапи: `checks-fast-core`, `checks-fast-contracts-channels`, `checks-node-extensions`, `checks-node-core-test`, лише для PR `extension-fast`, `checks`, `checks-windows`, `macos-node`, `macos-swift` і `android`. -Логіка області дії міститься в `scripts/ci-changed-scope.mjs` і покрита модульними тестами в `src/scripts/ci-changed-scope.test.ts`. -Зміни workflow CI перевіряють граф Node CI разом із lint для workflow, але самі по собі не примушують запускати нативні збірки Windows, Android або macOS; ці платформні етапи й надалі обмежуються змінами у вихідних кодах відповідних платформ. -Перевірки Windows Node обмежені Windows-специфічними process/path wrappers, npm/pnpm/UI runner helpers, конфігурацією менеджера пакетів і поверхнями workflow CI, які виконують цей етап; не пов’язані зміни вихідного коду, plugin, install-smoke та зміни лише тестів залишаються на Linux Node-етапах, щоб не резервувати Windows worker на 16 vCPU для покриття, яке вже перевіряється звичайними тестовими шардами. -Окремий workflow `install-smoke` повторно використовує той самий скрипт області дії через власне завдання `preflight`. Він обчислює `run_install_smoke` на основі вужчого сигналу changed-smoke, тому Docker/install smoke запускається для змін, пов’язаних з установленням, пакуванням, контейнерами, production-змін bundled extension, а також для поверхонь core plugin/channel/gateway/Plugin SDK, які використовують Docker smoke jobs. Зміни лише тестів і лише документації не резервують Docker workers. Його QR package smoke примушує Docker-шар `pnpm install` виконатися повторно, зберігаючи при цьому кеш сховища BuildKit pnpm, тож він усе одно перевіряє встановлення без повторного завантаження залежностей у кожному запуску. Його gateway-network e2e повторно використовує runtime image, зібраний раніше в цьому завданні, тому додає реальне покриття WebSocket між контейнерами, не додаючи ще одну Docker-збірку. Окреме завдання `docker-e2e-fast` запускає обмежений Docker-профіль bundled-plugin з тайм-аутом команди 120 секунд: repair залежностей setup-entry плюс ізоляція синтетичного збою bundled-loader. Повна матриця оновлень bundled і каналів залишається ручною/для повного набору, оскільки вона виконує повторні реальні проходи npm update і doctor repair. +Логіка обмеження за областями міститься в `scripts/ci-changed-scope.mjs` і покривається unit-тестами в `src/scripts/ci-changed-scope.test.ts`. +Зміни workflow CI перевіряють граф Node CI разом із linting workflow, але самі по собі не примушують запускати нативні збірки Windows, Android або macOS; ці платформені етапи й далі обмежуються змінами у вихідному коді платформи. +Перевірки Windows Node обмежені обгортками process/path, специфічними для Windows, допоміжними засобами запуску npm/pnpm/UI, конфігурацією package manager і поверхнями workflow CI, що запускають цей етап; не пов’язані зміни у вихідному коді, plugins, install-smoke і лише в тестах залишаються на Linux Node етапах, щоб не резервувати 16-vCPU Windows worker для покриття, яке вже перевіряється звичайними шардованими тестами. +Окремий workflow `install-smoke` повторно використовує той самий скрипт обмеження за областями через власне завдання `preflight`. Він обчислює `run_install_smoke` на основі вужчого сигналу changed-smoke, тому Docker/install smoke запускається для змін, релевантних для встановлення, пакування, контейнерів, production-змін у bundled extension, а також для core поверхонь plugin/channel/gateway/Plugin SDK, які перевіряють Docker smoke-завдання. Зміни лише в тестах і лише в документації не резервують Docker workers. Його smoke перевірка QR package змушує Docker-шар `pnpm install` виконатися повторно, зберігаючи кеш BuildKit pnpm store, тому вона все одно перевіряє встановлення без повторного завантаження залежностей на кожному запуску. Його gateway-network e2e повторно використовує runtime image, зібраний раніше в цьому завданні, тож додає реальне покриття WebSocket між контейнерами без додавання ще однієї Docker-збірки. Окреме завдання `docker-e2e-fast` запускає обмежений Docker-профіль bundled-plugin із тайм-аутом команди 120 секунд: відновлення залежностей setup-entry плюс синтетична ізоляція збоїв bundled-loader. Повна матриця bundled update/channel залишається ручною/full-suite, оскільки виконує повторні реальні проходи npm update і doctor repair. -Локальна логіка changed-lane міститься в `scripts/changed-lanes.mjs` і виконується через `scripts/check-changed.mjs`. Цей локальний gate суворіший щодо архітектурних меж, ніж широка область дії платформ у CI: production-зміни core запускають core prod typecheck плюс core tests, зміни лише core tests запускають лише core test typecheck/tests, production-зміни extension запускають extension prod typecheck плюс extension tests, а зміни лише extension tests запускають лише extension test typecheck/tests. Зміни в публічному Plugin SDK або plugin-contract розширюють перевірку до extension, тому що розширення залежать від цих core-контрактів. Підвищення версій лише в release metadata запускають цільові перевірки version/config/root-dependency. Невідомі зміни в root/config безпечно переводять виконання на всі етапи. +Логіка локальних changed-lane міститься в `scripts/changed-lanes.mjs` і виконується через `scripts/check-changed.mjs`. Цей локальний gate суворіший щодо архітектурних меж, ніж широке платформене обмеження CI: production-зміни core запускають core prod typecheck плюс core тести, зміни лише в core tests запускають тільки core test typecheck/tests, production-зміни extension запускають extension prod typecheck плюс extension тести, а зміни лише в extension tests запускають тільки extension test typecheck/tests. Зміни у публічному Plugin SDK або plugin-contract розширюють перевірку на extensions, оскільки extensions залежать від цих core-контрактів. Підвищення версії лише в release metadata запускають точкові перевірки version/config/root-dependency. Невідомі зміни в root/config безпечно переводять виконання на всі етапи. -Під час push матриця `checks` додає етап `compat-node22`, який виконується лише для push. У pull request цей етап пропускається, і матриця лишається зосередженою на звичайних test/channel-етапах. +Для push матриця `checks` додає етап `compat-node22`, який запускається лише для push. Для pull request цей етап пропускається, і матриця залишається зосередженою на звичайних test/channel етапах. -Найповільніші сімейства Node-тестів розділені або збалансовані так, щоб кожне завдання лишалося невеликим: контракти каналів розділяють покриття registry і core загалом на шість зважених шардів, тести bundled plugin збалансовані між шістьма workers для extension, auto-reply виконується як три збалансовані workers замість шести крихітних workers, а agentic gateway/plugin configs розподілені між наявними source-only agentic Node jobs замість очікування на зібрані артефакти. Широкі browser, QA, media і miscellaneous plugin tests використовують свої окремі конфігурації Vitest замість спільного універсального набору plugin-тестів. Широкий етап agents використовує спільний file-parallel scheduler у Vitest, оскільки в ньому домінують імпорт і планування, а не один повільний тестовий файл. `runtime-config` виконується разом із шардом infra core-runtime, щоб спільний runtime-shard не тягнув хвіст виконання. `check-additional` тримає разом compile/canary-роботи для package-boundary і відокремлює їх від gateway/architecture-робіт runtime topology; шард boundary guard виконує свої невеликі незалежні guards паралельно в межах одного завдання, а регресія gateway watch використовує мінімальний профіль збірки `gatewayWatch` замість повторної повної перебудови всього набору sidecar-артефактів CI. -`extension-fast` існує лише для PR, оскільки push-запуски вже виконують повні шарди bundled plugin. Це дає швидкий зворотний зв’язок щодо змінених plugin під час рев’ю, не резервуючи додатковий Blacksmith worker у `main` для покриття, яке вже є в `checks-node-extensions`. +Найповільніші сімейства Node-тестів поділені або збалансовані так, щоб кожне завдання залишалося невеликим: контракти channel ділять покриття registry і core загалом на шість зважених шардів, тести bundled plugin розподіляються між шістьма extension workers, auto-reply виконується як три збалансовані workers замість шести крихітних workers, а agentic-конфігурації gateway/plugin розподілені між наявними source-only agentic Node jobs замість очікування зібраних артефактів. Широкі browser-, QA-, media- та різні plugin-тести використовують свої окремі конфігурації Vitest, а не спільний універсальний набір для plugins. Широкий етап agents використовує спільний файлово-паралельний планувальник Vitest, оскільки тут домінують імпорти/планування, а не один повільний тестовий файл. `runtime-config` запускається разом із шардом infra core-runtime, щоб спільний runtime-шард не залишався власником хвоста. `check-additional` тримає разом compile/canary роботу package-boundary і відокремлює її від gateway/architecture роботи з runtime topology; шард boundary guard запускає свої невеликі незалежні guards паралельно всередині одного завдання, а регресія gateway watch використовує мінімальний профіль збірки `gatewayWatch` замість повторної збірки повного набору sidecar-артефактів CI. +Android CI запускає і `testPlayDebugUnitTest`, і `testThirdPartyDebugUnitTest`, а потім збирає Play debug APK. Flavor third-party не має окремого source set або manifest; його етап unit-тестів усе одно компілює цей flavor із прапорцями SMS/call-log BuildConfig, при цьому уникаючи дубльованого завдання пакування debug APK для кожного Android-релевантного push. +`extension-fast` доступний лише для PR, оскільки для push уже виконуються повні шардовані тести bundled plugins. Це зберігає швидкий зворотний зв’язок для reviews щодо змінених plugins, не резервуючи додатковий Blacksmith worker у `main` для покриття, яке вже є в `checks-node-extensions`. -GitHub може позначати замінені завдання як `cancelled`, коли новіший push потрапляє в той самий PR або ref `main`. Сприймайте це як шум CI, якщо тільки найновіший запуск для того самого ref також не завершується з помилкою. Агреговані shard checks використовують `!cancelled() && always()`, тому вони все одно повідомляють про звичайні збої шардiв, але не стають у чергу після того, як увесь workflow уже було замінено новішим. -Ключ concurrency у CI має версію (`CI-v6-*`), щоб zombie-процес на боці GitHub у старій групі черги не міг безстроково блокувати нові запуски main. +GitHub може позначати витіснені завдання як `cancelled`, коли новіший push надходить у той самий PR або ref `main`. Сприймайте це як шум CI, якщо тільки найновіший запуск для того самого ref також не завершується з помилкою. Агреговані шардовані перевірки використовують `!cancelled() && always()`, тож вони все одно повідомляють про звичайні збої шардів, але не стають у чергу після того, як весь workflow уже був витіснений. +Ключ concurrency для CI має версію (`CI-v6-*`), щоб zombie-процес на боці GitHub у старій групі черги не міг безстроково блокувати новіші запуски для main. -## Виконавці +## Runners -| Виконавець | Завдання | -| -------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ubuntu-24.04` | `preflight`, швидкі завдання безпеки та агрегати (`security-scm-fast`, `security-dependency-audit`, `security-fast`), швидкі перевірки protocol/contract/bundled, шардовані перевірки контрактів каналів, шарди `check`, окрім lint, шарди та агрегати `check-additional`, агреговані верифікатори Node-тестів, перевірки документації, Python Skills, workflow-sanity, labeler, auto-response; preflight для install-smoke також використовує GitHub-hosted Ubuntu, щоб матриця Blacksmith могла ставати в чергу раніше | -| `blacksmith-8vcpu-ubuntu-2404` | `build-artifacts`, build-smoke, шарди Linux Node-тестів, шарди тестів bundled plugin, решта споживачів built-artifact, `android` | -| `blacksmith-16vcpu-ubuntu-2404` | `check-lint`, який і надалі достатньо чутливий до CPU, тож 8 vCPU коштували дорожче, ніж заощаджували; Docker-збірки install-smoke, де вартість часу очікування в черзі для 32 vCPU була вищою за виграш | -| `blacksmith-16vcpu-windows-2025` | `checks-windows` | -| `blacksmith-6vcpu-macos-latest` | `macos-node` у `openclaw/openclaw`; форки повертаються до `macos-latest` | -| `blacksmith-12vcpu-macos-latest` | `macos-swift` у `openclaw/openclaw`; форки повертаються до `macos-latest` | +| Runner | Завдання | +| -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `ubuntu-24.04` | `preflight`, швидкі завдання безпеки й агрегатори (`security-scm-fast`, `security-dependency-audit`, `security-fast`), швидкі перевірки protocol/contract/bundled, шардовані перевірки контрактів channel, шарди `check`, окрім lint, шарди й агрегатори `check-additional`, агреговані верифікатори Node-тестів, перевірки документації, Python Skills, workflow-sanity, labeler, auto-response; preflight для install-smoke також використовує GitHub-hosted Ubuntu, щоб матриця Blacksmith могла стати в чергу раніше | +| `blacksmith-8vcpu-ubuntu-2404` | `build-artifacts`, build-smoke, шарди Linux Node-тестів, шарди тестів bundled plugin, решта споживачів зібраних артефактів, `android` | +| `blacksmith-16vcpu-ubuntu-2404` | `check-lint`, який залишається достатньо чутливим до CPU, тож 8 vCPU коштували дорожче, ніж давали економію; Docker-збірки install-smoke, де час очікування в черзі на 32 vCPU коштував дорожче, ніж давав економію | +| `blacksmith-16vcpu-windows-2025` | `checks-windows` | +| `blacksmith-6vcpu-macos-latest` | `macos-node` у `openclaw/openclaw`; forks повертаються до `macos-latest` | +| `blacksmith-12vcpu-macos-latest` | `macos-swift` у `openclaw/openclaw`; forks повертаються до `macos-latest` | ## Локальні еквіваленти @@ -91,7 +92,7 @@ pnpm test:gateway:watch-regression pnpm test # тести vitest pnpm test:channels pnpm test:contracts:channels -pnpm check:docs # форматування документації + lint + биті посилання +pnpm check:docs # docs format + lint + биті посилання pnpm build # зібрати dist, коли важливі етапи CI artifact/build-smoke node scripts/ci-run-timings.mjs # підсумувати загальний час, час у черзі та найповільніші завдання ```