Українська
GitHub Actions
Крок 1. Навіщо машина перевіряє кожну зміну
Навіщо. У Chatex уже діють суворі правила: попередження вважаються помилками, стиль коду перевіряється під час збирання, кожна зміна моделі потребує міграції, поведінку охороняють 142 тести. Але правила, які запускаються лише тоді, коли хтось про це згадає, нічого не захищають. Один колега забуває перевірку форматування, в іншого на ноутбуці стара міграція, третій надсилає «крихітне виправлення», не запустивши тестів. А фраза «в мене збирається» мало що доводить: на вашій машині є кеші, локальні налаштування й файли, яких немає в репозиторії.
Безперервна інтеграція (continuous integration, CI) розв’язує обидві проблеми: після кожного надсилання свіжа машина отримує саме те, що надіслано, запускає всі перевірки й позначає коміт зеленим або червоним – для всіх. Проблеми виявляються за кілька хвилин після появи, і виявляє їх той, хто їх створив.
Chatex використовує GitHub Actions – службу CI, вбудовану в GitHub. Jenkins, GitLab CI чи Azure Pipelines виконали б ту саму роботу, але потребують або ще одного сервера, або ще одного хостингу; Actions працює там, де вже живе репозиторій, і не потребує нічого, крім файлу YAML у ньому. Виконавці, що їх надає GitHub, безкоштовні для публічних репозиторіїв; приватні репозиторії отримують щомісячну квоту безкоштовних хвилин, значно більшу, ніж потрібно цьому проєкту.
Словник GitHub Actions
Таблиця 22.1 показує терміни, які вживаються в цій темі та двох наступних.
Таблиця 22.1. Терміни GitHub Actions
| Термін | Значення | У Chatex |
|---|---|---|
| робочий процес (workflow) | автоматизований процес, один файл YAML у .github/workflows/ | ci.yml (ця тема), deploy.yml (тема 24) |
| подія (тригер) | те, що запускає робочий процес: надсилання, запит на злиття, кнопка, інший робочий процес | pull_request, push до dev, workflow_call |
| завдання (job) | набір кроків, що виконується на одній машині; завдання робочого процесу йдуть паралельно, якщо одне не вказує needs на інше | backend, frontend |
| крок (step) | одна команда (run:) або одна повторно використовувана дія (uses:) усередині завдання; кроки йдуть по черзі, і перший невдалий крок провалює завдання | Restore, Check formatting, npm ci, … |
| виконавець (runner) | машина, що виконує завдання; виконавець, наданий GitHub, – це нова віртуальна машина для кожного завдання, яку потім видаляють | ubuntu-latest |
| дія (action) | повторно використовуваний крок, опублікований у репозиторії, на який посилаються як owner/name@version | actions/checkout@v7, actions/setup-dotnet@v6 |
| артефакт (artifact) | файли, які завдання вивантажує й зберігає разом із запуском – для людей або наступних завдань | тут результати тестів, пакет релізу в темі 24 |
Крок 2. Файл робочого процесу
Навіщо. Робочий процес – це код: він лежить у репозиторії, перевіряється в запитах на злиття й змінюється разом із проєктом. GitHub автоматично запускає кожен файл YAML із .github/workflows/; на сайті нічого налаштовувати не потрібно.
Що зробити. Створіть у корені репозиторію папки .github/workflows і в них файл ci.yml. Це остаточна версія; наступні два розділи розбирають її два завдання крок за кроком.
yaml
# Build, lint and test the backend and the frontend.
# Runs on pull requests and pushes to dev; deploy.yml calls it before every production deploy.
name: CI
on:
pull_request:
push:
branches: [dev]
workflow_call:
permissions:
contents: read
concurrency:
# Called from deploy.yml, github.workflow is the caller's name, so the groups never collide.
group: ci-${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true
env:
DOTNET_NOLOGO: true
DOTNET_CLI_TELEMETRY_OPTOUT: true
jobs:
backend:
name: Backend
runs-on: ubuntu-latest
timeout-minutes: 20
steps:
- uses: actions/checkout@v7
- uses: actions/setup-dotnet@v6
with:
global-json-file: global.json
- name: Cache NuGet packages
uses: actions/cache@v6
with:
path: ~/.nuget/packages
key: nuget-${{ runner.os }}-${{ hashFiles('Directory.Packages.props', '**/*.csproj') }}
restore-keys: nuget-${{ runner.os }}-
- name: Restore
run: |
dotnet restore Chatex.slnx
dotnet tool restore
- name: Check formatting
run: dotnet format Chatex.slnx --verify-no-changes --no-restore
- name: Build
run: dotnet build Chatex.slnx -c Release --no-restore
- name: Check for model changes without a migration
run: dotnet ef migrations has-pending-model-changes --project Source/Chatex.Data --configuration Release --no-build
# Testcontainers starts PostgreSQL in the runner's Docker.
- name: Test
run: dotnet test --solution Chatex.slnx -c Release --no-build
- name: Upload test results
if: failure()
uses: actions/upload-artifact@v7
with:
name: test-results
path: '**/TestResults/**'
if-no-files-found: ignore
frontend:
name: Frontend
runs-on: ubuntu-latest
timeout-minutes: 15
defaults:
run:
working-directory: Source/Chatex.Web
steps:
- uses: actions/checkout@v7
- uses: actions/setup-node@v7
with:
node-version: 24
cache: npm
cache-dependency-path: Source/Chatex.Web/package-lock.json
- run: npm ci
# Only what ships to browsers; run a full npm audit by hand when updating dev tooling.
- run: npm audit --omit=dev --audit-level=high
- run: npm run format:check
- run: npm run lint
- run: npm test -- --watch=false
- run: npm run buildYAML за дві хвилини
Робочий процес – це документ YAML: пари key: value, вкладеність відступами з пробілів (ніколи не табуляцією), списки з - на початку рядка. run: | починає блок із кількох рядків, кожен із яких виконується як команда оболонки, тож Restore виконує дві команди. Текст після # – коментар. Хибний відступ не дає помилки у вашому редакторі, але GitHub відхиляє файл і показує рядок на сторінці Actions.
Крок 3. Тригери, права й паралельність
Навіщо. Початок файлу визначає, коли запускається робочий процес і що йому дозволено. Обидва питання варті уважного погляду: робочий процес, що запускається надто рідко, пропускає проблеми, а робочий процес із надто широкими правами – це ризик.
Що зробити. Прочитайте заголовок ci.yml:
yaml
name: CI
on:
pull_request:
push:
branches: [dev]
workflow_call:
permissions:
contents: read
concurrency:
# Called from deploy.yml, github.workflow is the caller's name, so the groups never collide.
group: ci-${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true
env:
DOTNET_NOLOGO: true
DOTNET_CLI_TELEMETRY_OPTOUT: truename: CI– назва, яку показують на сторінці Actions і поруч із комітами.on:перелічує три події.pull_requestперевіряє кожен запит на злиття – результат злиття гілки з цільовою, тож конфлікт, що ламає збирання, виявляється ще до злиття.pushізbranches: [dev]перевіряє кожне надсилання до робочої гілки.workflow_callдозволяє іншому робочому процесу викликати цей як будівельний блок:deploy.yml(тема 24) запускає весь CI перед кожним розгортанням, а не повторює кроки. Надсилання доmainсвідомо відсутнє в переліку: зміни потрапляють доmainчерез запити на злиття, які вже перевірено, аdeploy.ymlперевіряє ще раз.permissions: contents: readобмежує автоматичний токен, який отримує кожен запуск (GITHUB_TOKEN), читанням репозиторію. Перевірці більше нічого не потрібно, тож навіть скомпрометований інструмент збирання не зможе надіслати код чи змінити задачі. Це знову принцип найменших привілеїв – як для користувача бази даних і користувача служби далі в цьому модулі.concurrency:об’єднує запуски в групи; зcancel-in-progress: trueновий запуск скасовує старіший запуск тієї самої групи. Назва групи складається з двох виразів у подвійних фігурних дужках: назви робочого процесу й гілки (github.ref). Тому три швидкі надсилання доdevкоштують одного повного запуску, а не трьох. Коментар пояснює тонкий момент: колиdeploy.ymlвикликає цей робочий процес, виразgithub.workflow– це назва викликача («Deploy»), тож розгортання ніколи не скасовує звичайний запуск CI і саме не скасовується ним.env:задає змінні середовища для кожного кроку: без привітального банера .NET і без телеметрії з машини збирання.
Під заголовком jobs: визначає backend і frontend. Вони не залежать одне від одного, тож GitHub запускає їх одночасно на двох окремих виконавцях; запуск триває стільки, скільки повільніше завдання, а не обидва разом. Кожне завдання оголошує runs-on: ubuntu-latest – актуальний образ Ubuntu від GitHub із попередньо встановленими Docker, Git і поширеними інструментами – та обмеження timeout-minutes, тож тест, що завис, зупиняється через 20 хвилин, а не через шість годин за замовчуванням.
Вирази й секрети у файлах робочих процесів
Вираз у подвійних фігурних дужках GitHub обчислює до запуску кроку. Він може містити що завгодно з події, зокрема заголовок запиту на злиття, написаний стороннім. Ніколи не вставляйте такий вираз прямо в команду run:: передавайте його через env:, як це робить deploy.yml у темі 24, щоб оболонка бачила його як дані, а не як код.
Перевірка
powershell
git status --shortВивід містить ?? .github/. GitHub перевірить файл, коли ви надішлете його в розділі Запуск CI; до того переконайтеся, що ваш редактор не показує в ньому символів табуляції.