Zadokuję Twoją aplikację Node.js, Next.js lub Rust i skonfiguruję CI/CD za pomocą GitHub Actions lub GitLab CI

Jeśli Twoje wdrożenie to lista komend, które ktoś musi pamiętać, ta usługa ją zastępuje. Najpierw sprawiam, że aplikacja jest odtwarzalna, a następnie automatyczna: ten sam obraz działa na laptopie, w CI i na serwerze, a push do głównej gałęzi to wszystko, czego potrzeba do wydania.

Starter to kontener: produkcyjny Dockerfile, plik compose, który uruchamia aplikację i jej bazę danych lokalnie, oraz plik README, który pozwala nowemu programiście uruchomić wszystko jedną komendą. Standard dodaje potok, który instaluje, lintuje, uruchamia testy i buduje obraz przy każdym pushu oraz każdym pull lub merge request. Działa na GitHub Actions lub GitLab CI, w zależności od tego, gdzie znajduje się Twój kod. Advanced dodaje wdrożenie: po scaleniu z main, potok wysyła aplikację na Twój serwer Linux przez SSH lub do Railway lub Fly.io, które uruchamiają ten sam obraz, lub przekazuje aplikację Next.js do Vercel, która buduje ją na swój własny sposób. Klucze i tokeny wdrożeniowe są przechowywane w zaszyfrowanych tajnych danych GitHub lub chronionych zmiennych CI/CD GitLab, a nie w kodzie, i otrzymujesz pisemny sposób na wycofanie zmian.

Obrazy pozostają małe dzięki wieloetapowym kompilacjom, aplikacja działa jako użytkownik niebędący rootem, a konfiguracja pochodzi ze zmiennych środowiskowych, więc ten sam obraz służy do stagingu i produkcji. To samo podejście obejmuje aplikacje Node.js i Next.js, usługi Rust i strony statyczne.

Moje dwa publiczne projekty internetowe, witryna Next.js i moja osobista strona, pokazują stronę potoku: GitHub Actions buduje i wdraża oba przy każdym pushu do głównej gałęzi, i uruchamia testy jednostkowe i przeglądarkowe witryny przed wdrożeniem. Są to strony statyczne, więc są wysyłane bez kontenera. Po stronie Rust, mój otwarty kod ma potok GitHub Actions, który działa przy każdym pushu do main i każdym pull request: formatowanie, linty, testy, minimalna obsługiwana wersja Rust i sprawdzanie zależności. Jeśli używasz również Kubernetes, manifesty lub wykres Helm są dostępne jako dodatek.

Brak połączeń. Wszystko znajduje się w Twoim repozytorium i jest zapisane, więc potok nie zależy ode mnie. Przez 14 dni po dostarczeniu naprawiam wszystko, co nie działa zgodnie z naszymi ustaleniami, bezpłatnie.

Kroki do ukończenia Twojego projektu
1. Przeczytaj projekt – uruchamiam aplikację tak, jak Ty to robisz teraz i zapisuję jej zależności, zmienne środowiskowe, bazę danych i kroki budowania.
2. Kontener – Produkcyjny Dockerfile i plik compose do uruchamiania lokalnego, sprawdzone przez zbudowanie i uruchomienie aplikacji na czystej maszynie.
3. Potok – Instalacja, lintowanie, testy i budowanie obrazu w Twoim CI, przy pushach oraz przy pull lub merge requestach, z buforowaniem, aby pozostał szybki.
4. Wdrożenie – Na poziomie Advanced, zadanie, które wysyła aplikację po scaleniu z main, z kluczami i tokenami przechowywanymi w tajnych danych platformy CI i zapisanym krokiem wycofania zmian.
5. Przekazanie – Sekcja README dotycząca uruchamiania, testowania i wydawania, oraz co zmienić, gdy zostanie dodana nowa zmienna środowiskowa lub usługa.