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

Spouštět Kaloko v CI a komentovat pull requesty

V CI spouští Kaloko stejné příkazy jako na vašem počítači. Obvyklé nastavení projde na preview nasazení (Vercel, Netlify, Cloudflare Pages nebo jakákoli review app) to, co pull request změnil, a odkaz na plachtu napíše do komentáře v pull requestu.

1. Napište workflow

npx kaloko ci github     # zapíše .github/workflows/kaloko.yml
npx kaloko ci gitlab     # zapíše kaloko.gitlab-ci.yml; vložte ho do .gitlab-ci.yml přes include
npx kaloko ci github --print   # jen ukáže, nic nezapíše

--scenario a.yml,b.yml ho omezí na vybrané scénáře. Příkaz zároveň přidá do kaloko.config.yml prostředí preview s base_url: ${KALOKO_PREVIEW_URL}. Scénář, který vyjmenovává environments:, musí obsahovat i preview, jinak ho kaloko start odmítne; příkaz vám řekne, kterých scénářů se to týká.

2. Přidejte token

V Nastavení → API tokeny vytvořte token s rolí tester a přidejte ho do tajných proměnných CI v repozitáři jako KALOKO_TOKEN. Na GitLabu přidejte ještě KALOKO_GITLAB_TOKEN: project access token s rozsahem api, aby Kaloko mohlo napsat poznámku do merge requestu. Workflow commitněte.

Co workflow dělá

Po každém úspěšném preview nasazení pull requestu:

  1. Nainstaluje projekt a prohlížeč (npx kaloko browser install --with-deps), a když o ně scénář žádá, i WebKit a Firefox.
  2. npx kaloko ci preview-url --wait 600 --github-env najde adresu preview, pull request a jeho základní větev a předá je dál jako KALOKO_PREVIEW_URL, KALOKO_PR a KALOKO_BASE.
  3. U každého scénáře kaloko affected --fail-if-none zjistí, jestli změna zasahuje některý jeho krok. Pokud ne, scénář přeskočí, jinak spustí:
npx kaloko start --scenario qa/flows/checkout.yml --env preview
npx kaloko walk --ephemeral --affected
npx kaloko share --pr

share --pr přidá do pull requestu jeden komentář za každý scénář a při dalších pushích ho aktualizuje. Soubory se posílají podle obsahu, takže nezměněné screenshoty se znovu nenahrávají.

Kontrola Kaloko v pull requestu

S GitHub App Kaloko (nainstaluje ji správce v Nastavení → Integrace → GitHub, od plánu Team) dostane každý pull request v připojeném repozitáři jednu kontrolu Kaloko na posledním commitu. Zezelená, když běhy sdílené pro ten commit projdou nebo když se změna žádného scénáře netýká. Čeká, dokud scénář, kterého se změna týká, nemá běh, a zčervená, když některý selže. Běhy můžou přijít z tohoto workflow, od kódovacího agenta v cloudu i z notebooku: rozhoduje commit. Běh s necommitnutými změnami se nepočítá.

Pokud má merge počkat, až bude zelená, vyžadujte v ochraně větve status check Kaloko. Kaloko samo ochranu větví nikdy nemění.

  • Režimy (Nastavení, pro každý repozitář): vypnuto, ručně (jen po štítku kaloko:run nebo /kaloko walk), automaticky (výchozí) a přísně (všechny scénáře, povinné posouzení, časový limit).
  • Jeden pull request: štítky kaloko:skip, kaloko:all, kaloko:review, komentář /kaloko skip <důvod> (jen aktuální commit) nebo tlačítka přímo v kontrole. Přeskočit smí jen lidé s právem, které zvolil správce, nikdy aplikace ani boti, a kontrola ukáže, kdo ji přeskočil a proč.
  • V repozitáři: sekce github: v kaloko.config.yml na cílové větvi může kontrolu zpřísnit, nikdy uvolnit.
  • npx kaloko ci plan řekne kontrole přesně, kterých scénářů se commit týká. Vygenerované workflow ho posílá před procházením.
  • Kontrola se neobjevuje? Nastavení → Integrace → GitHub ukáže repozitáře a řekne proč, třeba že repozitář ještě není v instalaci aplikace.

Dobré vědět

  • walk --affected potřebuje historii gitu: na GitHubu checkout s fetch-depth: 0, na GitLabu GIT_DEPTH: "0".
  • --trigger pull_request spouští workflow při každém pushi místo události nasazení a na preview počká.
  • kaloko ci preview-url vypíše jen adresu, takže funguje v jakémkoli CI: export KALOKO_PREVIEW_URL="$(npx kaloko ci preview-url)".
  • Preview chráněné Vercel deployment protection potřebuje tajnou proměnnou VERCEL_AUTOMATION_BYPASS_SECRET a blok access.headers prostředí preview, který je ve vygenerované konfiguraci zakomentovaný.
  • Běhy sdílené z CI také porovnají kondici (kontroly z packů, které jen radí) s minulým během scénáře a při nové chybě dají vědět. npx kaloko health --fail-on error zastaví job kvůli chybám v kondici, pokud to tým chce.
  • V pull requestu se komentář neobjevil? Obvykle chybělo preview nasazení nebo token. Log jobu řekne, co z toho.

Pokud vaše vydání publikuje release-please, changesets nebo semantic-release, přidá npx kaloko ci github --release druhé workflow, které každé vydání zapíše do Kaloka. Všechny volby najdete v referenci CLI.

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