Kurs NestJS · Moduł 12: Konteneryzacja i CI/CD
Zaawansowane CI/CD - matrix builds, artifacts i cache
W tej lekcji6
Testy przechodzą u Ciebie. U kolegi nie - bo ma inną wersję Node'a. Na serwerze też nie, bo ktoś zapomniał przebudować obrazu. Każda z tych trzech sytuacji kosztuje pół dnia, a wszystkie mają wspólną przyczynę: sprawdzenie zależy od tego, kto i gdzie je uruchomił.
Continuous Integration usuwa tę zależność: to automatyczne budowanie i testowanie kodu po każdym push. Nie ręczne wdrażanie raz w tygodniu, nie monitorowanie pamięci i nie kopie zapasowe bazy - tylko jedno sprawdzenie, zawsze tak samo, na maszynie, której nikt nie skonfigurował po swojemu.
Kiedy uruchomić
Workflow zaczyna się od wskazania zdarzeń, które go budzą:
name: CI
on:
push:
branches: [main]
pull_request:on: pull_request uruchamia workflow przy tworzeniu pull requesta - i to jest ten moment, o który chodzi najbardziej, bo sprawdzenie odbywa się przed wejściem zmiany do gałęzi głównej.
on: push reaguje na wypchnięcie kodu; oba stosuje się zwykle razem. Istnieją też inne wyzwalacze, ale robią co innego: on: schedule uruchamia workflow o wyznaczonej porze, a on: deployment - przy zdarzeniu wdrożenia. Żaden z nich nie zadziała, gdy ktoś otworzy pull request.
Kolejność zadań
Pipeline dzieli się na joby, a ich kolejność nie jest dowolna:
- Lint - sprawdzenie formatowania.
- Build - kompilacja TypeScriptu.
- Test - testy jednostkowe.
- Docker build & push - zbudowanie i wysłanie obrazu.
Reguła porządkująca brzmi: najtańsze i najszybsze najpierw. Lint kończy się w kilka sekund, więc nie ma sensu czekać pięciu minut na testy, żeby dowiedzieć się o brakującym średniku. Kompilacja poprzedza testy, bo test nieskompilowanego kodu i tak nie ruszy. Obraz Dockera budujemy na końcu - to najdroższy krok i nie ma po co go zaczynać, jeśli cokolwiek wcześniej padło.
Krok po kroku
Każdy job składa się z kroków, a pierwszym jest zawsze pobranie kodu:
jobs:
test:
runs-on: ubuntu-latest
steps:
- name: Checkout kodu
uses: actions/checkout@v4
- name: Setup Node
uses: actions/setup-node@v4
with:
node-version: 20
- name: Instalacja zaleznosci
run: yarn install --frozen-lockfile
- name: Testy
run: yarn test --coverageBudowa kroku jest stała: - name: Checkout kodu, potem uses:, dalej actions/checkout@v4. name to opis widoczny w interfejsie, uses wskazuje gotową akcję, a run - polecenie do wykonania w powłoce.
Kolejność w jobie testowym też jest niezmienna: actions/checkout@v4 pobiera kod, actions/setup-node@v4 instaluje Node'a, yarn install --frozen-lockfile wciąga zależności, a na końcu yarn test --coverage uruchamia testy.
Flaga --frozen-lockfile zasługuje na uwagę: każe zainstalować dokładnie wersje z pliku blokady i przerwać, gdyby się nie zgadzały. Bez niej pipeline mógłby cicho zainstalować nowszą wersję zależności i przetestować coś innego, niż uruchomisz na produkcji.
Sekrety
Pipeline potrzebuje haseł - do rejestru obrazów, do serwera, do bazy testowej. Przechowujemy je w Settings > Secrets and variables > Actions, w ustawieniach repozytorium.
Nie w pliku .env w repozytorium, nie w komentarzu do commita, nie w README.md - wszystkie te miejsca są publiczne dla każdego, kto ma dostęp do kodu, a historii Gita nie da się tak po prostu wyczyścić.
Zapisany sekret wstawiasz do workflow przez odwołanie, nigdy wprost:
- name: Logowanie do rejestru
run: docker login -u ${{ secrets.REGISTRY_USER }} -p ${{ secrets.REGISTRY_TOKEN }}Wartość zostanie podstawiona przy uruchomieniu, a w logach pojawi się w postaci zamaskowanej.
Trzy usprawnienia
Na koniec trzy rzeczy, które odróżniają pipeline działający od pipeline'u, na który da się czekać.
Matrix uruchamia ten sam job na kilku konfiguracjach naraz:
strategy:
matrix:
node-version: [18, 20, 22]Trzy wersje Node'a, trzy równoległe przebiegi, jeden opis. To odpowiedź na problem z początku lekcji - „u kolegi nie działa" wychodzi teraz przy pull requeście, a nie po tygodniu.
Cache zapamiętuje pobrane zależności między przebiegami. Bez niego każdy przebieg ściąga te same paczki od nowa; z nim instalacja skraca się z minut do sekund.
Artifacts to pliki, które job zostawia po sobie - raport pokrycia, zbudowana paczka, zrzuty ekranu z testów. Przeżywają zakończenie przebiegu i można je pobrać z interfejsu, co bywa jedynym sposobem, by zrozumieć, dlaczego coś padło tylko na maszynie CI.
Podsumowanie
Sprawdzenie przestało zależeć od tego, kto je uruchamia:
- CI to automatyczne budowanie i testowanie kodu po każdym push - nie ręczne wdrażanie, nie monitoring pamięci, nie kopie zapasowe,
on: pull_requesturuchamia workflow przy tworzeniu pull requesta;on: scheduledziała o wyznaczonej porze,on: deploymentprzy wdrożeniu,- kolejność jobów: Lint → Build → Test → Docker build & push, według zasady „najtańsze najpierw",
- budowa kroku:
- name:, potemuses:, potem nazwa akcji;run:wykonuje polecenie powłoki, - job testowy w kolejności:
actions/checkout@v4,actions/setup-node@v4,yarn install --frozen-lockfile,yarn test --coverage, --frozen-lockfileinstaluje dokładnie wersje z pliku blokady i przerywa przy niezgodności,- sekrety trzymamy w Settings > Secrets and variables > Actions - nie w
.env, nie w komentarzu, nie wREADME.md, - matrix uruchamia job na kilku konfiguracjach równolegle, cache skraca instalację zależności, artifacts zachowują pliki po zakończeniu przebiegu.
W następnej lekcji zejdziemy z poziomu liczb do pojedynczego żądania - poznasz distributed tracing. A na razie zapamiętaj: pipeline to jedno sprawdzenie, wykonywane zawsze tak samo - a matrix sprawia, że „u mnie działa" przestaje być argumentem.
Kod do tej lekcji: src/github-actions.ts
// CI/CD z GitHub Actions - Cursus Publicus
console.log("=== CI/CD PIPELINE ===\n");
interface PipelineJob {
name: string;
description: string;
steps: string[];
runsAfter?: string;
}
const pipeline: PipelineJob[] = [
{
name: 'lint',
description: 'Inspekcja kodu',
steps: ['checkout', 'setup-node', 'yarn install', 'yarn lint'],
},
{
name: 'test',
description: 'Testy jednostkowe',
steps: ['checkout', 'setup-node', 'yarn install', 'yarn test --coverage'],
runsAfter: 'lint',
},
{
name: 'build',
description: 'Budowanie aplikacji',
steps: ['checkout', 'setup-node', 'yarn install', 'yarn build'],
runsAfter: 'test',
},
{
name: 'docker',
description: 'Docker image build & push',
steps: ['checkout', 'docker login', 'docker build & push'],
runsAfter: 'build',
},
];
pipeline.forEach((job, i) => {
const arrow = job.runsAfter ? ` (po: ${job.runsAfter})` : ' (start)';
console.log(`Job ${i + 1}: ${job.name}${arrow}`);
console.log(` Opis: ${job.description}`);
job.steps.forEach((s, j) => {
console.log(` Krok ${j + 1}: ${s}`);
});
console.log();
});
// Triggery
console.log("=== TRIGGERY WORKFLOW ===\n");
console.log("push na main -> pelny pipeline + deploy");
console.log("push na develop -> CI bez deploy");
console.log("pull_request -> CI (lint + test + build)\n");
// Sekrety
console.log("=== GITHUB SECRETS ===\n");
console.log("Hasla i klucze API przechowuj w:");
console.log(" Settings > Secrets > Actions");
console.log(" Nigdy w kodzie zrodlowym!");
Widzisz błąd w tej lekcji?
Sprawdź się
Odpowiedz na pytania z tej lekcji. Wybierz odpowiedź, a od razu zobaczysz, czy jest poprawna.
1. Co oznacza CI (Continuous Integration)?
2. Który trigger uruchamia workflow GitHub Actions przy tworzeniu pull requesta?
To 2 z 3 pytań do tej lekcji. Pozostałe rozwiążesz w grze.
Zadania praktyczne w grze
- Układanie w pionie
Uporządkuj joby pipeline CI/CD od pierwszego do ostatniego:
- Edytor kodu
Zdefiniuj kroki dla trzech jobów: lint (checkout, setup-node, install, lint), test (+ coverage), build (+ build)
- Układanie w poziomie
Ułóż elementy kroku checkout w GitHub Actions w prawidłowej kolejności:
- Klikanie w kolejności
Ułóż kroki joba 'test' w GitHub Actions w prawidłowej kolejności:
- Edytor kodu
Skonfiguruj helmet, compression, CORS, ValidationPipe i ThrottlerGuard w odpowiedniej kolejności
Zadania po tej lekcji
- PytanieCzym jest CI (Continuous Integration)
- Ułóż w kolejnościPowtórzenie: Kolejność jobów w pipeline CI/CD
- Zadanie z kodemPowtórzenie: Pipeline CI/CD z GitHub Actions
- PytaniePowtórzenie: Triggery GitHub Actions
- Ułóż w kolejnościPowtórzenie: Składnia uses w GitHub Actions
- Kliknij w kolejnościPowtórzenie: Kroki job test w CI
- PytaniePowtórzenie: GitHub Secrets w CI/CD pipeline
- Zadanie z kodemPraktyka: Middleware bezpieczeństwa NestJS