Jak Kaloko odpovídá vašim aplikacím
Jeden repozitář je málokdy jedna aplikace. V monorepu bývá aplikací několik, jedna aplikace se táhne přes víc repozitářů, agentura má projekt pro každého klienta a každý tým pojmenovává prostředí jinak. Kaloko proto pracuje s několika pojmy, které jednou přiřadíte ke své situaci.
Pojmy
| Pojem | Co to je | Obvyklé přiřazení |
|---|---|---|
| Organizace | účet vaší firmy nebo agentury | jedna na firmu |
| Produkt | to, co se vydává a verzuje jako celek, s vlastním changelogem a dokumentací | e‑shop, administrace, mobilní aplikace, balíček |
| Projekt | jednotka práce a přístupu: kdo ho vidí a kdo ho kontroluje | klient, tým, modul, celá aplikace |
| Modul | část produktu s vlastní sekcí v dokumentaci a changelogu | košík, účet, fakturace |
| Scénář a krok | flow a jeho obrazovky | patří k projektu; může uvést produkt a modul |
| Prostředí | kde flow běží | local, preview, staging, produkce, production-cz |
| Verze | vydaná verze produktu | z git tagů, package.json, vašeho nástroje na release nebo z kaloko release |
Produkty jsou volitelné
Bez produktů je produktem projekt a jeho changelog je changelog projektu. Tak začíná většina týmů. Až budete potřebovat víc, vypište produkty pod products: v kaloko.config.yml a scénáře uvedou svůj přes product: a module:. Nic se nemusí přesouvat.
Projekt může pokrývat několik produktů a na jednom produktu může pracovat víc projektů. Dokumentace a záznamy v changelogu odkazují na kroky, takže produkt a modul znají ze scénáře.
Verze patří produktům
Prostředí jen říká, kde běh proběhl. Běh je svázaný s verzí produktu a dokumentace pro verzi 2.4 ukazuje přijaté běhy verze 2.4. Obrázky pocházejí z prostředí, které produkt určí jako referenční (reference_env), třeba staging u interního nástroje nebo production-cz u portálu jen pro Česko.
Čtyři obvyklá uspořádání
- Jedna aplikace, jeden tým. Žádné produkty; projekt je aplikace a má jeden changelog. To je výchozí stav.
- Monorepo s několika aplikacemi. Produkt pro každou aplikaci; projekty podle týmů nebo aplikací.
- Agentura. Projekt pro každého klienta a produkt pro každou dodávku. Hosté od klienta čtou jen changelog a dokumentaci svého produktu.
- Velká aplikace s moduly. Jeden produkt s moduly podle týmů. Každý tým se stará o dokumentaci svého modulu a release má jeden společný changelog se sekcí pro každý modul.
kaloko init navrhne produkt pro každou aplikaci ve složce apps/, která má vlastní package.json. kaloko products sync je pošle do Kaloka ještě před prvním vydáním a Produkty v menu aplikace ukážou každý produkt, který čtete.
Každá část funguje sama
Můžete používat jen changelog, jen dokumentaci, jen dokumentaci jednoho modulu, jen obrázky pro web s dokumentací, který už máte (kaloko export), nebo jen e‑mail „Co je nového“. Nic nevyžaduje celou sadu.