Inżynieria
Changelog jako artefakt builda: konwencje, automatyzacja, pipeline'y.
Zacznij tutaj: Keep a Changelog: wyjaśnienie i szablon CHANGELOG.md, Od conventional commits do changelogu, Automatyzacja changelogu: co automatyzować, a czego nie
-
Co to jest hotfix? Znaczenie, hotfix a patch, jak go wydać
Hotfix to pilna poprawka wydana poza zwykłym cyklem wydań. Co oznacza ten termin, czym różni się od patcha lub bugfixa i jak wydać go bezpiecznie.
Inżynieria5 min czytania
-
Release candidate (RC): co oznacza i jak go poprowadzić
Release candidate to build wydawany jako finalna wersja, jeśli testy nie znajdą blokera. Miejsce RC po becie, wersjonowanie i kryteria wyjścia.
Inżynieria4 min czytania
-
CHANGELOG.md: co w nim jest i jak trzymać go aktualnym
CHANGELOG.md to zapis dla czytelnika tego, co zmieniło się w każdej wersji. Potrzebne sekcje, pełny przykład i jeden nawyk, który utrzymuje plik aktualnym.
Inżynieria5 min czytania
-
GitHub release notes: wygenerujcie je, potem zredagujcie
GitHub szkicuje release notes ze scalonych pull requestów jednym kliknięciem. Co zawiera szkic, jak kształtuje go release.yml i jak go zredagować.
Inżynieria6 min czytania
-
Proces zarządzania wydaniami dla zespołów wydających często
Proces zarządzania wydaniami w siedmiu krokach, z właścicielem i kryteriami wyjścia dla każdego, plus metryki DORA i jeden dodatkowy wskaźnik do śledzenia.
Inżynieria7 min czytania
-
Kto pisze changelog, i kto powinien
Kto pisze changelog? Autorka PR wie, co się zmieniło, PM wie, dlaczego to ważne. Żadna sama nie napisze dobrego wpisu, a domyślny wybór postarza changelog.
Inżynieria5 min czytania
-
Formaty plików changeloga: JSON, YAML czy zwykły Markdown
Format pliku changeloga decyduje, czy zasili stronę i widżet, czy przeczyta go tylko człowiek. Markdown, JSON i YAML kosztują zupełnie coś innego.
Inżynieria5 min czytania
-
Wymagaj wpisu w changelogu w GitHub Actions: workflow
Check changelogu w GitHub Actions odrzuca merge bez wpisu, bo krok zależny od pamiętania zawodzi według wzorca. Do tego: co taki check psuje.
Inżynieria5 min czytania
-
Tagi git vs wydania GitHub vs changelog: różnice
Tag git, wydanie i wpis w changelogu to trzy zapisy jednego zdarzenia. Mieszanie ich sprawia, że changelog dryfuje. Jak te trzy powinny się zgadzać.
Inżynieria5 min czytania
-
Changelogi w monorepo: jeden, czy jeden na pakiet?
Monorepo może mieć jeden changelog dla całego repo albo jeden na pakiet, a zły wybór sprawia, że każde wydanie jest zbyt hałaśliwe albo zbyt rozproszone.
Inżynieria5 min czytania
-
Semantic versioning a changelog: co znaczy każdy skok
Semantic versioning mówi, jak bardzo wydanie może zaboleć, zanim ktoś przeczyta słowo z changeloga. Co obiecuje każda cyfra i co jest winny wpis.
Inżynieria5 min czytania
-
Publiczna strona changeloga: jak zbudować taką do śledzenia
Strona changeloga jest warta zbudowania, gdy ktoś na nią wraca. Gdzie powinna mieszkać, czego potrzebuje wpis, strumienie i markup, i gdzie pasuje widżet.
Inżynieria5 min czytania
-
Automatyzacja changelogu: co automatyzować, a czego nie
Automatyzujcie zbieranie, formatowanie i publikację. Nie automatyzujcie selekcji ani sformułowania. Gdzie leży granica i co się dzieje, gdy się przesuwa.
Inżynieria6 min czytania
-
Od conventional commits do changelogu
Conventional commits sprawiają, że changelog da się wyprowadzić, ale nie że jest czytelny. Co daje ta konwencja, gdzie się zatrzymuje i jak wypełnić lukę.
Inżynieria5 min czytania
-
Keep a Changelog: wyjaśnienie i szablon CHANGELOG.md
Keep a Changelog to specyfikacja na jedną stronę, czytana w dziesięć minut. Wdrożenie to miejsce, gdzie zespoły od niej odchodzą. Co mówi, co zostawia.
Inżynieria5 min czytania