Jak předat studentské demo

Máte práci vedenou pod UXlabem a chcete ji zpřístupnit na tomto serveru? Uložte podklady pro nasazení přímo do repozitáře. E-mail slouží jako oznámení nové verze. Správce nebo plánovaná kontrola načte informace z konkrétního commitu, takže se neztratí v poště.

1. Připravte repozitář

Uložte projekt na fakultní GitLab. U soukromého projektu zajistěte přístup vedoucímu. Pro předání použijte konkrétní commit nebo tag.
Webovou aplikaci připravte pro Linux x86-64 pomocí Dockerfile. Pokud potřebuje více služeb, přidejte soubor Docker Compose. Čistě statický web může obsahovat sestavení a výsledný adresář bez backendu.
Do README napište přesný příkaz pro sestavení a spuštění, port aplikace, požadované proměnné prostředí a způsob ověření funkčnosti. Uveďte také požadavky na RAM, disk a případné externí služby.
Přidejte .env.example s názvy proměnných a ukázkovými hodnotami. Skutečné klíče a hesla předejte správci samostatně bezpečným způsobem.
Přiložte testovací data a popište, zda se nějaká data mají zachovat po aktualizaci. U databáze uveďte inicializaci, migrace a postup obnovy.

2. Přizpůsobte demo jeho adrese

Obvyklá adresa má podobu https://uxlab.ksi.fit.cvut.cz/demo/nazev-projektu/. Aplikace musí umět nastavit tento prefix pro odkazy, statické soubory, API a přesměrování. Pokud to vaše technologie neumožňuje nebo potřebujete samostatnou doménu, napište to při předání a domluvte řešení se správcem.

Server spravuje UXlab. K předání postačí repozitář a návod ke spuštění. Napište, zda má být demo veřejné, nebo určené jen testerům. U placených API popište, kdo hradí spotřebu a jak je omezena.

3. Přidejte soubor uxlab-deploy.json

Stáhněte šablonu uxlab-deploy.json, upravte ji pro svůj projekt a commitněte do kořene repozitáře společně s návodem ke spuštění. Obsahuje kontakt, typ aplikace, cestu, konfiguraci, data, externí služby, prostředky a ověření funkčnosti. U klíčů uvádějte pouze názvy proměnných.

Formát popisuje JSON schema v1. Soubor runbook odkazuje na návod v repozitáři, entrypoint na Compose soubor, Dockerfile nebo adresář statického webu. verification.path je cesta relativní ke kořeni dema, například /healthz.

Pro další vydání aktualizujte manifest i návod a vytvořte nový commit. Pro nasazení vždy určete plný 40znakový SHA commitu. Všechny podklady se čtou z této přesné verze.

4. Oznamte připravený commit

Pošlete oznámení na ondrej.brem@fit.cvut.cz pomocí připraveného e-mailu. Nahraďte zástupné hodnoty. Zachovejte následující formát pro plánovanou kontrolu.

Předmět

[UXLAB-DEPLOY v1] <slug> <full-commit-sha>

Tělo

UXLAB_DEPLOY_REQUEST_V1
repository=https://gitlab.fit.cvut.cz/namespace/project
commit=<full-40-character-commit-sha>
manifest=uxlab-deploy.json
operation=deploy

Technické informace zůstávají v repozitáři. Stejný commit oznamte pouze jednou. Opakované oznámení stejné verze se zpracuje jako jeden požadavek. U soukromého repozitáře zajistěte přístup vedoucímu a správci.

Co se stane potom

Plánovaná kontrola ověří manifest, dohledá konfiguraci a připraví podklady. Stav, schválený commit a výsledek nasazení se zaznamenávají do requests/<slug>.json v repozitáři správy UXlabu. Vedoucí nebo správce schválí konkrétní verzi. Poté lze provést nasazení, ověřit hlavní scénář a přidat odkaz na rozcestník. Samotné oznámení e-mailem nepředstavuje schválení.

GitLab CI může sestavovat a publikovat kontejnery. Pro běžné aktualizace zůstává stejný postup předání přesného commitu a manifestu. Přidání běžného dema pod existující adresu řeší UXlab.

Konfiguraci serveru a příklady pro správce najdete v repozitáři UXlab demo-deploy. Přístup k soukromému repozitáři vyžaduje členství ve skupině UXlab. Tento veřejný návod obsahuje vše potřebné pro první předání.