Skip to content

logger

Dokumentacja techniczna

Zestaw funkcji bash do formatowanego logowania w jobach CI/CD — nagłówki, bannery kolorowe, komunikaty krytyczne.

Wyświetla wyróżniony blok z tekstem: kolorowa linia tła na górze i dole, tekst wycentrowany pośrodku.

Szerokość bloku: term_width (domyślnie 130 znaków).

KolorTekstTło linii
redczerwonyczerwone
greenzielonyzielone
blueniebieskiniebieskie
yellowżółtyżółte
(inne)domyślnydomyślne

Nagłówek pierwszego poziomu — pogrubiony tekst wycentrowany między dwiema liniami = w kolorze niebieskim.

==============================================================
                        Tytuł sekcji
==============================================================

Nagłówek drugiego poziomu — prefix ==> w kolorze żółtym, tekst biały/pogrubiony.

==> Komunikat

Nagłówek trzeciego poziomu — prefix ---> w kolorze niebieskim.

---> Szczegół

Alias dla banner blue. Używany do komunikatów informacyjnych.


Alias dla banner yellow. Używany do ostrzeżeń.


Alias dla banner red, po którym następuje exit 1. Kończy wykonanie joba z błędem.

ZmiennaDomyślna wartośćOpis
term_width130Szerokość linii bannera i nagłówka h1 w znakach

Helper jest wstrzykiwany po job-prepare w before_script i after_script:

before_script:
  - !reference [.common.job-prepare.sh]
  - !reference [.common.logger.script.sh]   # ← funkcje dostępne od tej chwili
  - !reference [.common.logo.script.sh]

Przykład użycia w skrypcie joba:

h1 "Etap budowania"
h2 "Pobieranie zależności"
h3 "npm install"

info "Budowanie zakonczone sukcesem"
warn "Brak pliku .npmrc — uzywam domyslnych ustawien"
critical "Nie znaleziono pliku package.json"   # przerywa job