Integrace GitLab

0 Úvod

GitLab Integration je doplněk, který lze přidat ke kterémukoli ze tří plánů Easy Redmine.

Účelem pluginu je agregovat důležitá data z GitLab v Easy Redmine za účelem pomoci s reportováním, hodnocením a prezentací vývojových aktivit, a tím podporovat rozhodování ze strany zainteresovaných stran, které investují do projektů vývoje softwaru a procesů společnosti. společnost.

Mezi jeho možnosti patří velmi jednoduché počáteční připojení k vaší instanci GitLab (jak samostatně hostované, tak cloudové verze). Po navázání připojení Easy Redmine zobrazí nejdůležitější položky z GitLab v konfigurovatelných a filtrovatelných seznamech (podobných seznamu úkolů). Tyto entity jsou:

Úložiště
Sloučit žádosti
Přiznává
Zkoušky

včetně jejich nejdůležitějších vlastností.

Klíčovým prvkem integrace je, že Easy Redmine NEKOpíruje úložiště fyzicky. Kód zůstává v GitLabu.

1 Navazování spojení

Nejprve musíte mít přístupový token od uživatele v GitLab se správnými oprávněními.

Vyberte uživatele, přes kterého bude Easy Redmine přistupovat ke GitLabu. Může se jednat o speciálního uživatele, přes kterého se žádná osoba nepřihlásí, např. er_integrator
Upravit profil tohoto uživatele
Přejděte na Přístupové tokeny, vyberte všechna oprávnění a Vytvořte osobní přístupový token
Zkopírujte tento token

Nyní můžete přejít na Easy Redmine a zadat důležité informace
Přejděte na Správce >> Integrace GitLab >> Najít Dostupné integrace a hit Konfigurace
Pojmenujte své připojení, zadejte adresu URL a dříve vygenerovaný přístupový token.
Poznámka: V případě cloudu, např https://gitlab.com/my-little-gitlab , stačí zadat https://gitlab.com/ bez podadresy URL. Není třeba se obávat, můžete vidět pouze projekty, které vidí uživatel s přístupovým tokenem. Pokud nastavíte všechny své projekty jako soukromé, nikdo jiný je neuvidí.
Uložit
A je to! Připojení je provedeno.

Vše ostatní se děje automaticky na pozadí. Zejména

Easy Redmine načte všechny projekty/úložiště, jejichž členem je uživatel s přístupovým tokenem
V těchto úložištích se vytvářejí webhooky => takže info o nový potvrzení, požadavky na sloučení a testy budou odeslány do Easy Redmine

1.1 Odstraňování problémů s připojením

Problém A
Nevidím žádné úložiště z této instance GitLab
V důsledku nepředvídatelných okolností se může stát, že výše uvedené operace nebudou úspěšně provedeny. V důsledku toho možná neuvidíte žádné úložiště z této instance GitLab v Easy Redmine.

V takovém případě můžete importovat úložiště ručně pomocí několika kliknutí.

Přejděte na Správce >> Integrace Gitlabu >> Nakonfigurované integrace >> Klikněte na název
V postranní nabídce klikněte na import
Vyberte skupinu
S GitLab s vlastním hostitelem bude existovat skupina zastupující celou instanci. Jako v příkladu ze snímku obrazovky.
S cloudovým GitLab uvidíte všechny veřejné skupiny a pravděpodobně budete muset svou skupinu vyhledat. Pole se automaticky doplňuje, takže vyhledávání je rychlé a snadné.
Po jeho výběru a odkliknutí se zobrazí seznam nalezených projektů/úložišť
Vyberte vše a stiskněte import

Problém B
Úložiště byla nalezena, ale moje nové commity, požadavky na sloučení a testy nejsou přidány do Easy Redmine
Nová data z GitLabu jsou odesílána do Easy Redmine prostřednictvím webhooků nakonfigurovaných v GitLabu. Za normálních okolností jsou vytvářeny automaticky. Můžete si to ověřit ve svém projektu GitLab >> Nastavení >> Webhooky

Pokud neexistuje webhook s odkazem na vaši aplikaci, budete jej muset vytvořit. Opět se jedná o jednoduchou operaci.

Přejděte na Správce >> Integrace Gitlabu >> Nakonfigurované integrace >> Klikněte na název
V postranní nabídce klikněte na Úložiště
Klikněte na jméno jednoho z nich
Klikněte na Zaregistrujte všechny integrace

To ručně vynutí vytvoření webhooku ve správném tvaru.

2 Odkazování na klíčová slova

Nyní, když je nakonfigurováno obecné připojení, již máte informace z GitLab v Easy Redmine a můžete je využít. Chcete-li však integraci plně využít, existuje několik dalších nastavení. Některé jsou již přednastaveny a můžete je pouze zkontrolovat.

Je možné připojit konkrétní potvrzení nebo požadavky na sloučení s konkrétními úkoly a dokonce tímto způsobem zaznamenávat čas, aniž byste museli navštívit Easy Redmine. To se provádí tzv odkazující klíčová slova. Když je použijete ve zprávě odevzdání nebo názvu žádosti o sloučení v kombinaci s ID úlohy, vytvoří se propojení mezi úlohou a položkou GitLab. Nejběžnější příklady jsou reference #1234 or zavírá #1234

Ve většině případů najdete několik přednastavených referenčních klíčových slov. Zde je návod, jak s nimi pracovat.

Přejděte do nabídky Více >> Integrace GitLab >> Reference
Vytvořte nebo upravte referenci
Celý formulář obsahuje popisky, které vám pomohou se v nich orientovat

Nejdůležitější pravidla k zapamatování jsou:

Úkol musí být identifikován ve tvaru #ID , např. #1234
Doba protokolování (je-li povolena) se vždy zadává jako @XhYm , např. @1h30m
Při odevzdáních je třeba zadat referenční klíčová slova do potvrzení zprávy
Při požadavcích na sloučení je třeba zadat klíčová slova odkazující na název žádosti o sloučení

3 Mapování uživatelů

Protože se zabýváme integrací dvou různých aplikací, každá má různé skupiny uživatelů. Všechny uživatelské atributy v entitách souvisejících s GitLab (autor odevzdání, recenzent na žádost o sloučení atd.) v Easy Redmine + strávený čas přihlášený pomocí odkazujících klíčových slov by měly být spojeny se skutečnými uživateli. Jak jsou tedy vlastně uživatelé z GitLab mapováni na Easy Redmine?

Není zde nic vědeckého, uživatelé jsou jednoduše mapováni prostřednictvím e-mailu v obou uživatelských profilech. Ujistěte se prosím, že vaši vývojáři mají v GitLabu i Easy Redmine stejné e-maily.

Pokud se jednomu uživateli z nějakého důvodu nedaří sjednotit emaily v obou aplikacích, je zde možnost zadat další email v Easy Redmine v uživatelském profilu -> zde zadejte email GitLab.

4 Jak to funguje

Konečně se dostáváme k té zábavné části. Co vlastně integrace dělá pro uživatele. Vstupte na hlavní stránku/dashboard integrace GitLab přes nabídku Více (vpravo nahoře) v sekci Doplňky.

Ve výchozím stavu najdete přizpůsobitelnou stránku, kterou si později můžete vyladit podle svých potřeb.

Obsahuje také nabídku pro výpis entit nebo zadání nastavení. Jak bylo zmíněno v úvodu, Easy Redmine shromažďuje a zobrazuje 4 klíčové entity z GitLabu. Pojďme se na každou z nich podívat blíže.

4.1 Úložiště

Seznam úložišť je funkčně nejméně zajímavý, i když skutečně nezbytný. Užitečný filtr, který stojí za zmínku, je tzv Servis, který využijete v případě, že máte propojené různé instance GitLabu a potřebujete prohledávat jen některé z nich.

Název úložiště obsahuje také název jeho skupiny.

Detail úložiště

Poznámky:

(Zrušte) registraci všech integrací byly popsány v kapitole 1.1. Vytvoří/odstraní webhooky v projektu GitLab.
Změnit - ručně změnit některé atributy. Neexistuje žádný jiný důvod než pokročilé ladění upravovat jakékoli atributy úložiště v Easy Redmine.
Synchronizovat - stáhne všechna aktuální data z úložiště.
Sloučit žádosti - vypíše všechny požadavky na sloučení v tomto úložišti.
Vyberte šablonu sekvence - stále ve vývoji, dejte nám prosím více času na vyleštění tohoto robustního nástroje.

4.2 Požadavky na sloučení (žádosti o kód)

Měli bychom si ujasnit, proč existují dvě jména. Žádost o sloučení je termín používaný v GitLabu. Jiné nástroje pro to mají například různé názvy Vytáhněte požadavek. Integrační mechanismus našeho nástroje je napsán obecně, abychom mohli rozšířit podporu na další platformy Git. Proto v aplikaci a obrázcích můžete najít štítek Žádost o kód, což je obecný termín, který lze použít pro žádosti o sloučení nebo žádosti o stažení.

Požadavek na sloučení je bohatá entita (ukládá všechny důležité atributy), která umožňuje vytvářet pěkné výpisy, sestavy a grafy nad nimi přímo v Easy Redmine.

Detail žádosti o sloučení

Poznámky:

Název žádosti o sloučení obsahuje odkazující klíčové slovo "refs" následované ID úkolu s hash #765 - proto byl propojen s úkolem 765
Kliknutím na Synchronizovat aktualizuje všechna data tohoto MR z GitLabu
Všechny atributy lze zobrazit v seznamu žádostí o sloučení
Všechny atributy kromě SHA lze použít jako filtry v seznamu/zprávě/grafu žádostí o sloučení
Seznam požadavků na sloučení obsahuje také atributy testů (CI/CD), které se k němu vztahují, především - Stav testu

4.3 Závazky

Podobně jako u žádostí o sloučení nabízí seznam odevzdání také rozsáhlé možnosti hlášení. Seznam odevzdání obsahuje také atributy z testů.

Commit nemá vlastní detailní zobrazení v Easy Redmine. Prostě to není potřeba. Kliknutím na URL (nebo SHA) budete přesměrováni na jeho detail v GitLabu.

Testy 4.4

Byly zmíněny ve vztahu k výše uvedeným subjektům. Testy mají také svůj vlastní seznam pro generování různých zpráv. Pravděpodobně nejběžnějším využitím bude živé zobrazení testů na kritických úložištích, jako jsou kandidáti na vydání.

Test také nemá vlastní detailní zobrazení, kliknutím se dostanete do GitLabu.

4.5 Synergie - pohled z úlohy

Pojďme se podívat, jak to všechno jde dohromady.

1 Celkový stav entit GitLab souvisejících s tímto úkolem. Může obsahovat různé kombinace barev (červená, oranžová, zelená) a ikon (zaškrtnutí, křížek). Nejlepší je samozřejmě zelené zaškrtnutí v zeleném rámečku
Kombinace závisí na stavu požadavku(ů) sloučení a výsledcích testů souvisejících s potvrzeními a požadavky na sloučení. Jeho účelem je na první pohled ukázat, jak probíhá „technický“ průběh tohoto úkolu, užitečného zejména pro QA nebo delivery manažery.

2 Název úložiště (úložišť), do kterého byly provedeny změny týkající se tohoto úkolu. Kliknutím na odkaz budete přesměrováni na seznam těchto závazků.

3 Název požadavků na sloučení odkazujících na tento úkol. Kliknutím na něj budete přesměrováni na detail MR v Easy Redmine.
V případě, že existují pouze potvrzení odkazující na tuto úlohu, ale chybí požadavek na sloučení, je tato hodnota prázdná.

4 Stav každé žádosti o sloučení. Kliknutím na něj budete přesměrováni na detail žádosti o sloučení v GitLabu.
V případě, že existují pouze potvrzení odkazující na tuto úlohu, ale chybí požadavek na sloučení, je tato hodnota prázdná.

5 Výsledek posledního testovacího běhu v žádosti o sloučení. Kliknutím na něj budete přesměrováni na pipeline v GitLabu. Nelze na něj kliknout Neznámý stav (potrubí neexistuje).
V případě, že existují pouze odevzdání odkazující na tuto úlohu, ale chybí požadavek na sloučení, hodnota ukazuje výsledek posledního testu spuštěného při posledním odevzdání.

6 Spustit test ručně – kliknutím spustíte kanál ručně (dostanete se do GitLabu).

7 Kliknutím vytvoříte žádost o sloučení. Užitečné, když máte pouze sadu odevzdání, ale chybí vám MR (dostane vás do GitLabu).

4.6 Vytvořit větev z úlohy

(Poznámka: Funkce dostupná od 11plus.6.0)

Některým uživatelům se hodí vytvořit větev přímo z úkolu.

Tlačítko najdete v Více menu na detail úkolu

V poli automatického doplňování vyberte úložiště. Název pobočky je předvyplněn ID úkolu a předmětem, ale můžete jej změnit. Zdrojová větev je předvyplněna mistr

Větev uvidíte jako značku v sekci Gitlab integrace na úloze. Je klikací a vede na pobočku v GitLabu.

5 Oprávnění

Aktuálně existují dvě oprávnění.

Zobrazit – Přístup k doplňku z nabídky Více
Spravovat – upravit řídicí panel

Globální konfigurace je přístupná pouze správci Easy Redmine.