Dokumentace

Kaloko

Stáhnout
Markdown s obrázky (.zip)Složka pro Docusaurus (.zip)Složka pro VitePress (.zip)Složka pro MkDocs (.zip)HTML pro offline čtení (.zip)PDFNovinky jako JSON
Stránky

Kontrola kondice aplikace

Klient chce nový košík. Běh se vrátí červený, protože stránce s objednávkou chybí meta popis, o který nikdo nežádal. Kaloko proto takové kontroly drží stranou: kontroly z packů (SEO, přístupnost, výkon, použitelnost, konzole, chybové stránky, obrazovky aplikací) tvoří kondici aplikace. Běží při každém průchodu, ale nikdy nerozhodují, jestli krok nebo běh prošel. O přijetí dál rozhodují kritéria ze zadání.

PřijetíKondice
Otázkadělá práce, co se zadalo?je aplikace v dobrém stavu?
Odkud jsou kritériaze zadání, z ticketu, od lidíz packů, automaticky
Počítá se do verdiktuanone, jen radí
Hlavně pročlověka, který schvalujeagenta před review; tým v čase

Jak ji zapnout

Kondice vzniká z packů kroku, stejně jako dřív:

nodes:
  - id: home
    packs: [seo, a11y, perf, console]

Výjimkou je pack design: kontroluje práci proti návrhu, který tým přijal, a proto se do přijetí počítá vždy. Všechny packy a to, na co se která jejich kontrola dívá, najdete v Kontrolách kondice.

Když se scénář prochází na designovém prostředí, packy, které splní jen kód (seo, aeo, perf, console, errors), jsou vypnuté: HTML od designéra nemá skutečný server, meta značky ani chybové stavy. Pokud některý chcete zachovat, uveďte ho v health: { design_packs: [...] }. Které packy jsou zapnuté a které ne, ukazuje stránka scénáře v aplikaci.

Jak ji číst

Po průchodu vypíšou kaloko walk a kaloko evaluate jeden řádek s počty. Podrobnosti:

npx kaloko health                 # aktuální lokální běh
npx kaloko health --remote        # sdílený běh na kaloko.app
npx kaloko health --json          # pro skripty a agenty

Každý nález má závažnost. Chyba znamená, že lidé nebo vyhledávače zůstanou venku: stránka vyřazená z indexace, chybějící viewport pro telefony, chyby v konzoli, tlačítko bez názvu, past pro klávesnici. Varování je všechno ostatní, třeba příliš dlouhý titulek nebo pomalá stránka. Nejisté znamená, že si evaluátor nebyl jistý. Výpis také řekne, co přibylo nebo se spravilo od minulého běhu scénáře, a ke každé kontrole, jak ji opravit.

Na plachtě má kondice vlastní kartu. V panelu běhu je Kondice vedle Souhrnu: počty, změna proti minulému běhu a nálezy podle packů nebo kroků; kliknutím se krok otevře na kartě Kondice, vedle Kritérií, kde jsou jen akceptační kritéria. Kontroly kondice mají vlastní id (HC103), takže si je nikdo nesplete s akceptačními kritérii (AC1, AC2…). Seznamy běhů ukazují počty jako malý odznak a stránka Kondice u projektu kreslí vývoj v čase.

S --fail-on error skončí kaloko health kódem 1, když jsou v kondici chyby. Použijte to jen tam, kde má kondice zastavit pipeline; nic jiného v Kaloku kvůli kondici neselže.

Jak z kontroly udělat kritérium přijetí

Někdy kontrola kondice do zadání patří („každá produktová stránka má meta popis do 155 znaků“). Převezměte ji, beze změny nebo vlastními slovy:

npx kaloko health adopt product:HC103 --text "Každá produktová stránka má meta popis do 155 znaků"

Kontrola se zapíše do souboru scénáře jako kritérium AC103 kroku, s from: HC103, a od dalšího průchodu rozhoduje o jeho verdiktu. V kondici kroku už HC103 nebude. Starší běhy, které kontrolu označují AC103, přijmou i toto id. Na plachtě udělá totéž tlačítko Převzít do kritérií u nálezu, pro lidi s rolí Developer / Tester; agent ho do scénáře zapíše příkazem kaloko health pull.

Chcete-li nechat v přijetí celý pack, jako tomu bylo před zavedením kondice, uveďte ho ve scénáři:

health:
  acceptance: [seo]

Jak se dozvědět, že se kondice zhoršila

Hostované běhy a běhy sdílené z CI porovnají kondici s minulým během scénáře. Když přibude nová chyba, Kaloko dá vědět sledujícím scénáře do schránky a e‑mailem, napíše do kanálů ve Slacku a Teams, které odebírají „Zhoršená kondice“, a pošle webhook health.worse. U každého plánu si vyberete, jestli hlásit nové chyby (výchozí), i nová varování, nebo nic: Nastavení → Integrace → Běhy na serveru Kaloka.

Na této stránceNa této stránce