Українська
Запуск CI
Крок 1. Ті самі перевірки перед надсиланням
Навіщо. CI знаходить проблему за кілька хвилин після надсилання, але надсилання вже публічне, а виправлення потребує ще одного коміту й ще одного запуску. Більшості червоних запусків можна уникнути: якщо розробник запускає ті самі перевірки перед надсиланням, CI стає підтвердженням, а не відкриттям. Перевірки мають бути тими самими, а не схожими: локальний скрипт, що пропускає аудит, пройде, поки CI провалиться.
Це команда check скрипта Run.ps1, написана в темі 2 і придатна до використання відтепер:
powershell
'check' {
# The same steps as .github/workflows/ci.yml.
Invoke-Step dotnet 'restore', $Solution
Invoke-Step dotnet 'tool', 'restore'
Invoke-Step dotnet 'format', $Solution, '--verify-no-changes', '--no-restore'
Invoke-Step dotnet 'build', $Solution, '-c', 'Release', '--no-restore'
Invoke-Step dotnet 'ef', 'migrations', 'has-pending-model-changes', '--project', $DataProject, '--configuration', 'Release', '--no-build'
Invoke-Step dotnet 'test', '--solution', $Solution, '-c', 'Release', '--no-build'
Invoke-Step npm 'ci' -WorkingDirectory $Web
Invoke-Step npm 'audit', '--omit=dev', '--audit-level=high' -WorkingDirectory $Web
Invoke-Step npm 'run', 'format:check' -WorkingDirectory $Web
Invoke-Step npm 'run', 'lint' -WorkingDirectory $Web
Invoke-Step npm 'test', '--', '--watch=false' -WorkingDirectory $Web
Invoke-Step npm 'run', 'build' -WorkingDirectory $Web
Write-Host 'All checks passed.' -ForegroundColor Green
}Порівняйте її з ci.yml рядок за рядком: дванадцять команд – це кроки двох завдань у тому самому порядку з тими самими параметрами. Invoke-Step зупиняється на першій невдалій команді, так само як завдання зупиняється на першому невдалому кроці. Лише кеші й вивантаження результатів тестів не мають локального відповідника. Коли змінюєте один файл, змінюйте й другий.
Що зробити. Запустіть Docker, потім виконайте з кореня репозиторію:
powershell
./Run.ps1 checkПеревірка
Кожна команда друкується сірим перед запуском (> dotnet restore Chatex.slnx, > dotnet tool restore, …). У виводі ви бачите No changes have been made to the model since the last migration., total: 93 і failed: 0 для серверної частини, found 0 vulnerabilities, All matched files use Prettier code style!, All files pass linting., Tests 49 passed (49) і таблицю збирання для production. Останній рядок зелений:
All checks passed.Перший запуск триває кілька хвилин; наступні швидші, бо пакети й образ PostgreSQL кешуються.
Docker is either not running or misconfigured
Тести серверної частини завершуються з цим повідомленням від Testcontainers, коли Docker Desktop не запущено. Запустіть його, зачекайте, доки він повідомить, що рушій працює, і виконайте перевірку знову.
Крок 2. Гілка dev і перший запуск
Навіщо. Робочий процес запускається під час надсилання до dev і для запитів на злиття – але не під час надсилання до main. Це модель гілок Chatex: щоденна робота йде до dev (або до коротких гілок функцій, які зливаються в dev), а main отримує завершений стан через запит на злиття. Починаючи з теми 24, кожна зміна main розгортається на сервері, тож main має містити лише перевірений код.
Що зробити. Закомітьте робочий процес у main, потім створіть із нього гілку dev і опублікуйте обидві гілки. (Якщо ви ще не створили репозиторій на GitHub, спершу виконайте кінець розділу Команди розробника.)
powershell
git add .powershell
git commit -m "Add the CI workflow"powershell
git pushpowershell
git switch -c devpowershell
git push -u origin devНадсилання dev запускає робочий процес. Відкрийте репозиторій на GitHub і вкладку Actions: у списку з’явиться запуск, названий за повідомленням коміту, «Add the CI workflow», з робочим процесом CI, гілкою dev і подією push.
Перевірка
Відкрийте запуск. Граф показує два завдання, Backend і Frontend, що працюють паралельно. Натисніть завдання, щоб побачити його кроки; кожен крок розгортається в журнал з тими самими рядками, що й у вашому терміналі. Приблизно за п’ять хвилин обидва завдання матимуть зелену позначку, і коміт на вкладці Code гілки dev теж покаже зелену позначку; якщо навести на неї курсор, з’явиться список CI / Backend (push) і CI / Frontend (push).
Крок 3. Читання невдалого запуску
Навіщо. Червоний запуск корисний, лише якщо ви швидко знаходите причину. Порушимо правило навмисно – на тимчасовій гілці, щоб dev залишилася зеленою, – і пройдемо слідом через запит на злиття.
Що зробити. Створіть гілку й зіпсуйте форматування одного файлу: відкрийте Source/Chatex.Api/Program.cs і додайте два пробіли після var app =.
powershell
git switch -c try-redpowershell
git commit -am "Break the formatting on purpose"powershell
git push -u origin try-redНа GitHub банер пропонує Compare & pull request для нової гілки. Створіть запит на злиття з базою dev і порівнянням try-red. Подія pull_request запускає для нього CI; саме надсилання до try-red не запустило б, бо лише dev указано під push.
Перевірка
Запит на злиття показує «Some checks were not successful»: Backend має червоний хрестик, Frontend – зелену позначку. Details біля Backend відкриває завдання: крок Check formatting червоний, наступні кроки сірі (пропущені), а Upload test results виконався завдяки if: failure(), але не знайшов, що вивантажувати. Журнал червоного кроку містить
…/Source/Chatex.Api/Program.cs(14,11): error WHITESPACE: Fix whitespace formatting. Delete 2 characters. […/Source/Chatex.Api/Chatex.Api.csproj]із файлом, рядком і стовпцем (шлях починається з робочої папки виконавця). Така сама помилка з’являється й як анотація на сторінці підсумку запуску.
Закрийте запит на злиття без злиття, потім видаліть гілку локально й на GitHub:
powershell
git switch devpowershell
git branch -D try-redpowershell
git push origin --delete try-redЯк читати будь-який червоний запуск
Починайте з першого червоного кроку: усе після нього пропущено й нічого не повідомляє. Спершу прочитайте кінець його журналу – помилка майже завжди в останніх рядках. Потім відтворіть її локально тією самою командою (./Run.ps1 check запускає їх усі); ніколи не «виправляйте» CI, надсилаючи здогади. Запуск, що провалився з причини поза вашим кодом, – тайм-аут під час завантаження пакетів чи збій GitHub, – можна повторити кнопкою Re-run jobs на сторінці запуску.
Крок 4. Захист main
Навіщо. Досі CI лише повідомляє; ніщо не заважає червоній зміні потрапити до main. Набори правил (rulesets) GitHub перетворюють повідомлення на «ворота»: тоді main може змінюватися лише через запит на злиття із зеленими перевірками. У темі 24 це стає життєво важливим, бо кожна зміна main розгортається.
Що зробити. На GitHub відкрийте Settings → Rules → Rulesets → New ruleset → New branch ruleset і заповніть:
- Ruleset name:
main, Enforcement status: Active; - Target branches: Add target → Include default branch (це
main); - Branch rules: залиште Restrict deletions і Block force pushes, увімкніть Require a pull request before merging і Require status checks to pass; у другому натисніть Add checks і виберіть Backend та Frontend.
Перевірки можна вибрати лише після того, як вони один раз виконалися в репозиторії, тому ми спершу запустили CI. Збережіть набір правил кнопкою Create.
Набори правил у приватних репозиторіях
На безкоштовному особистому обліковому записі GitHub застосовує набори правил лише в публічних репозиторіях. Для приватного репозиторію він зберігає набір правил, але показує, що той не діятиме, доки обліковий запис не буде оновлено; студенти безкоштовно отримують GitHub Pro разом із GitHub Student Developer Pack. Без примусового застосування дотримуйтеся правила самі: зливайте в main лише через запит на злиття із зеленими перевірками.
Перевірка
Відкрийте запит на злиття з базою main і порівнянням dev. Він показує перевірки Backend і Frontend як обов’язкові, а кнопка злиття лишається вимкненою, доки обидві не зелені. Поки що не зливайте: злиття в main розгортає з теми 24, а сервера ще немає. Прямий git push до main тепер відхиляється повідомленням, що зміни треба вносити через запит на злиття (лише коли набір правил застосовується).