Návody FIT
Jdi na navigaci

Webové prostředí

Tato stránka pokrývá základní úkony ve službě GitLab, a to čistě pomocí webového rozhraní bez nutné znalosti práce s Git. Avšak například pro rozsáhlejší práci s repozitářem je doporučeno projekt upravovat lokálně.

Samotné práci s Git se pak věnují kolegové z předmětu BI-GIT v jejich Velmi stručném přehledu Git.

Přihlášení

Služba se nachází na stránce https://gitlab.fit.cvut.cz/.

  • Osoby s účtem ČVUT – využívají formulář pod záložkou Usermap, přihlašují se pomocí uživatelského jména a hesla ČVUT.
  • Osoby bez účtu ČVUT – využívají formulář pod záložkou Standard, přihlašují se pomocí údajů, které jim byly poskytnuty.
login 01.en
Obrázek 1. Přihlašovací stránka https://gitlab.fit.cvut.cz/

Práce s projektem

Přejděte do požadovaného projektu – např. pomocí vyhledávače v horní nabídce.

Upozornění:

Pro úpravu souboru je potřeba disponovat příslušným oprávněním pro daný projekt. Pokud oprávněním nedisponujete, obraťte se na jeho vlastníka.

Úprava souborů

Úprava souborů je možná následujícími způsoby:

  • Úprava jednoho souboru
    • V případě AsciiDoc nebo Markdown umožňuje provést náhled změn před uložením.
  • Úprava více souborů naráz s pomocí webového IDE

Pro úpravu jednoho souboru využijte následující postup:

  1. Přejděte do požadovaného souboru.

    open file.cs

  2. Klikněte na Edit a z menu zvolte Edit single file.

    edit file.cs

  3. Proveďte požadované změny. Alternativně lze využít Preview (náhled).

    preview file.cs

  4. Vyplňte Commit message (stručný popis změn) a uložte Commit changes.

    commit file.cs

Webové IDE

Tzv. Web IDE umožňuje provést úpravy více souborů v rámci jednoho commitu.

Upozornění:

Webové IDE neumožňuje u souborů AsciiDoc, Markdown apod. provést náhled změn před uložením.

  1. Klikněte na tlačítko Edit v horní části detailu projektu a spusťte webový editor stiskem tlačítka Web IDE.

    web ide 01.en

  2. Práce s webovým editorem GitLab je principem podobná libovolnému IDE. V levé části otevřete soubory pro úpravu – takto otevřených souborů je možné mít více.

    web ide 02.en

  3. Upravte libovolné soubory. Pro potvrzení změn přejděte na stránku Source Control. Do pole Commit message vyplňte stručný popis změn a potvrďte stisknutím tlačítka Commit to <název větve> v horní části stránky.

    web ide 03.en

Nahrání souborů

Nahrání souborů o menší velikosti (např. PDF, obrázky) je možné provést přes webové rozhraní.

  1. V požadovaném repozitáři přejděte na konkrétní lokaci, kam chcete soubor přidat.

  2. Stiskněte tlačítko + a zvolte Upload file v nabídce.

    upload file 01.en

  3. Vyberte požadovaný soubor, vyplňte stručný popis změn a stiskněte tlačítko Upload file.

    upload file 02.en

  4. Soubor byl úspěšně nahrán.

    upload file 03.en
Upozornění:

Větší soubory je silně doporučeno nahrávat pomocí Git Large File Storage (LFS) při práci lokálně – této metody nejde využít ve webovém prostředí.

Alternativně je doporučeno využít některá z bezpečných úložišť, které fakulta garantuje. Následně pak v projektu na GitLab pouze uvést odkaz. Jedním z takových úložišť je například Microsoft OneDrive.[1]

Vytvoření issue

Každý uživatel s právem číst projekt, v něm má také možnost zakládat tzv. Issues. Tyto tickety neslouží jen k nahlášení chyby, ale jejich prostřednictvím mají uživatelé možnost poskytnout vlastníkům projektu jakoukoliv zpětnou vazbu nebo nápady ke zlepšení.

Například studenti tak mohou poskytnout zpětnou vazbu vyučujícím ke stránce jejich předmětu.

  1. Pro založení issue přejděte do požadovaného projektu – např. pomocí vyhledávače v horní nabídce.

  2. V menu přejděte na stránku Plan › Issues a stiskněte New issue.

    create issue 01.en

  3. Vyplňte předmět a tělo issue. Lze přiložit přílohy nebo vzhled textu editovat prostřednictvím nabídky v levém horním rohu editoru.

    Dále je možné zvolit následující možnosti:

    1. Zobrazení náhledu - Viz záložka Preview.

    2. Neveřejné issue - Issue je možné založit také neveřejně, uvidí jej tak pouze vlastníci projektu.

      create issue 02.en

  4. Stisknutím Create issue issue vytvoříte.

    create issue 03.en

Odbavení issue

Uživatelé s rolí Reporter a vyšší mají možnost jednotlivé issues odbavovat.

  1. V menu projektu přejděte na stránku Plan › Issues a vyberte issue, který chcete řešit.

    solve issue 01.en

  2. V detailu issue je možné jej okomentovat, přiřadit kolegovi apod. případně je možné jej uzavřít stisknutím Close issue.

    solve issue 02.en

  3. Příklad odbavení issue.

    solve issue 03.en

Vytvoření větve

Projekt je možné větvit – tj. odloučit se od hlavní linie vývoje a pokračovat v práci, aniž by došlo k zásahu do ostatních linií (větví). Změny v některé z vedlejších větví je možné kdykoliv sloučit zpět do větve hlavní (zpravidla master).[2]

Existuje více způsobů, jak větev vytvořit.[3] Obecně lze však větev vytvořit následovně:

  1. V menu projektu přejděte na stránku Code › Branches a stiskněte New branch.

    create branch 01.en
  2. Vyplňte následující:
    1. Branch name - libovolný název větve.

    2. Create from - zvolte existující větev, commit nebo tag ze které(ho) chcete větvit. Pro volbu hlavní (výchozí) větve zvolte master.

      create branch 02.en
  3. Pokračujte stisknutím Create branch.

Práce ve větvi

Ve webovém prostředí lze mezi větvemi libovolně přepínat.

create branch 03.en

Následně je možné provádět standardní úpravy typu úprava, nahrání, smazání souboru atp.

Aktuálně procházená větev je zobrazena v levé horní části, viz obrázek.

create branch 04.en

Merge request

Merge request (v doslovném překladu požadavek na sloučení) je jedním ze způsobů sloučení libovolné větve do větve jiné. V rámci takového požadavku je možné pohodlně:

  • Porovnat změny s cílovou větví.
  • Vést diskuzi s kolegy nad jednotlivými změnami.
  • Požadavek schválit a provést tak sloučení.
  • Požadavek uzavřít, resp. zamítnout.

Nutnost vytvořit Merge request přichází v případě, že v daném projektu nedisponujete oprávněním slučovat větve. Samotné sloučení (schválení Merge request) pak může provést pouze uživatel s příslušným oprávněním v daném projektu.

Vytvoření Merge request pro existující větev provedete následujícím způsobem:

  1. V menu projektu přejděte na stránku Code › Branches a u požadované větve stiskněte New.

    create merge request 01.en

  2. Vyplňte údaje Title a Description. Větve, které chcete sloučit můžete změnit tlačítkem Change branches. Požadavek lze případně přiřadit osobě, která je za merge request zodpovědná (Assignee)[4], nebo osobě, která má merge request zkontrolovat a schválit (Reviewer). Dále je možné požadavek označit štítkem (Labels).

    Následně potvrďte stisknutím Create merge request.

    create merge request 02.en

  3. Seznam aktuálně otevřených merge requestů naleznete v menu projektu pod záložkou Merge requests. Detail zobrazíte kliknutím na název požadovaného merge request.

    create merge request 03.en
  4. V záložkách Overview, Commits a Changes (viz obrázek) naleznete základní přehled změn, které daný merge request přinese.
    • Overview - Obecný přehled merge requestu umožňující libovolnou diskuzi (např. s kolegy, studentem) nad danými změnami.
    • Commits - Seznam jednotlivých změn vůči cílové větvi (Target branch).

    • Changes - Přehledně zobrazené rozdíly (tzv. diff) proti cílové větvi (viz obrázek).

      create merge request 04.en

  5. Po celou dobu existence daného merge requestu je možné jej komentovat. Možnost přidávat nebo číst komentáře se odvíjí od práv uživatele.

    create merge request 05.en
  6. Člen projektu s příslušným oprávněním může merge request kdykoliv:
    1. Zamítnout s pomocí Close merge request.

    2. Schválit a sloučit tak změny do cílové větve (Target branch), a to s pomocí Merge.

      create merge request 06.en

Nastavení výchozí větve

V některých případech může být potřeba přenastavit výchozí větev projektu například na větev master. Změna výchozí větve na větev master je doporučena například při publikování statických stránek pomocí služby PagesFIT.

  1. V menu projektu přejděte na stránku Settings › Repository.

    default branch 01.en

  2. V sekci Branch defaults vyberte v poli Default branch vaši novou výchozí větev.

    default branch 02.en
  3. Volbu potvrďte kliknutím na tlačítko Save changes.

Práce se skupinou

Možnost vytvářet skupiny je v tuto chvíli dostupná pouze pracovníkům. Více informací ke skupinám a skupinám předmětu viz sekce Skupiny.

Členové

Přidat člena do skupiny mohou pouze členové s rolí Maintainer a vyšší.

Upozornění:

U předmětových skupin probíhá mimo jiné automatická synchronizace uživatelů podle dat z KOS. Více viz Předmětové skupiny.

Pro úpravu členů přejděte na stránku Manage › Members v menu daného projektu.

members.en

Uživatele je možné přidat (preferujte také nastavení expirace jeho členství v dané skupině – např. na konec dalšího semestru), změnit datum expirace, změnit roli atp.

Vytvoření podskupiny

  1. Přejděte na hlavní stránku dané skupiny a zvolte vytvořit novou podskupinu viz obrázek.

    group detail.en
    Obrázek 2. Detail skupiny při vytváření nové podskupiny nebo projektu.

  2. Vyplňte libovolné údaje a potvrďte Create group.

    subgroup.en
    Obrázek 3. Detail procesu vytváření nové skupiny.
  1. Microsoft OneDrive disponuje rozšířenými metodami pro správu přístupu a udělování práv. ↩
  2. Změny je možné sloučit obecně do jakékoliv jiné větve. ↩
  3. Alternativní způsob vytvoření větve je vytvoření větve z existujícího issue. ↩
  4. Zpravidla se jedná o osobu, která je zodpovědná za změny provedené v merge requestu a je schopná provést finální sloučení. ↩