Cvičení – přidání odznáčku buildu

  • 7 min

Je důležité, aby členové týmu znali stav sestavení. Snadný způsob, jak rychle zjistit stav sestavení, je přidat odznáček sestavení do souboru README.md na GitHubu. Pojďme se podívat, jak je tým hotový.

Andy sedí za svým stolem a probírá své e-maily. Odpovídá na třetí e-mail, který souvisí se stavem sestavení pro web Space Game .

Andy: Musí existovat nějaký způsob, jak automatizovat stavovou zprávu. Máme kanál, proto bychom měli být schopní někam umístit stav. Možná Mara ví, jak to můžeme udělat.

Andy najde Maru, jak mluví s Amitou v kuchyňce.

Andy: Ahoj, Amita. Mohl bych si Maru na chvilku půjčit?

Amita: Stejně se musím dostat na schůzku. Půjč si ji, jak dlouho chceš.

Mara: Ahoj Andy. O co jde?

Andy: Opravdu se mi líbí změny, které jsme provedli v kanálu buildu pomocí Azure Pipelines, a Git je skvělý systém pro správu verzí. Zajímalo by mě, že existuje způsob, jak dát lidem vědět stav sestavení?

Mara: Ano, vlastně. Můžeme použít odznáček buildu.

Co je odznáček buildu?

Odznáček je součástí Microsoft Azure Pipelines. Má metody, které můžete použít k přidání obrázku SVG zobrazujícího stav buildu ve vašem úložišti na GitHubu.

Většina úložišť GitHubu obsahuje soubor s názvem README.md, což je soubor Markdownu, který obsahuje základní podrobnosti a dokumentaci k vašemu projektu. GitHub tento soubor vykreslí na domovské stránce vašeho projektu.

Tady je příklad odznáčku buildu:

Screenshot of GitHub showing the build badge. The status shows that the most recent build succeeded.

V tomto cvičení zpřístupníte odznáček buildu všem uživatelům. To nemusí být vhodné pro vaše soukromé projekty, protože informace o sestavení budou zpřístupněny veřejnosti.

Pokud chcete zkontrolovat, jestli je odznáček buildu viditelný:

  1. V Azure DevOps přejděte do vaší organizace.

  2. V dolním rohu vyberte nastavení organizace.

  3. V části Kanály vyberte Nastavení.

  4. Vypněte možnost Zakázat anonymní přístup k odznáček.

    Screenshot Azure DevOps showing how to disable anonymous access to badges.

Potřebujete provést podobnou změnu projektu:

  1. Přejděte na svůj projekt.
  2. V dolním rohu přejděte do nastavení Projectu.
  3. V části Kanály vyberte Nastavení.
  4. Vypněte možnost Zakázat anonymní přístup k odznáček.

Přidání odznáčku buildu

Až dosud jste pro provádění změn v projektu Space Game vytvářeli místní větve Gitu. Můžete ale také navrhnout změny přímo přes GitHub. V této části nastavíte odznáček stavu.

  1. V Azure DevOps v levém podokně vyberte Kanály a pak vyberte váš kanál.

  2. V pravém horním rohu vyberte tři tečky (...) a pak vyberte Odznáček Stav.

    Screenshot of Azure Pipelines showing the options menu to set the build badge.

  3. V části Sample Markdown (Ukázka Markdownu) vyberte tlačítko Kopírovat a zkopírujte kód Markdownu do schránky.

  4. Na GitHubu přejděte do svého projektu.

  5. Ujistěte se, že jste ve main větvi. V oblasti souborů otevřete soubor README.md .

  6. Výběrem možnosti Upravit tento soubor (ikona tužky) otevřete soubor v editoru.

  7. V horní části stránky přidejte prázdný řádek a vložte obsah schránky.

  8. Výběrem karty Náhled zobrazíte navrhované změny.

    GitHub vykreslí soubor Markdown a zobrazí odznáček buildu.

    Screenshot of GitHub showing a preview of the build badge.

Potvrzení změn do hlavní části

V této části potvrdíte změny do větve na GitHubu main .

  1. Vyberte Potvrdit změny.

  2. V oblasti Potvrzení zprávy zadejte zprávu potvrzení, například Přidat odznáček buildu.

    Screenshot of GitHub showing the commit message.

  3. Nechte možnost Potvrdit přímo na vybranou main větev a pak vyberte Potvrdit změny a potvrďte změny do main větve.

    Na stránce README.md se zobrazí váš odznáček.

    Screenshot of the final build badge as it appears on the README page.

    Tento proces představuje jednodušší způsob, jak sloučit kód do GitHubu. Namísto přímého potvrzení můžete vytvořit žádost o přijetí změn, ve které si vyžádáte, aby ostatní vaše změny zkontrolovali.

    V praxi byste přešli na main větev a stáhli nejnovější změny z GitHubu při příštím přidání funkce nebo vyřešení chyby.

Andy: Mara, právě jste udělali změnu přímo na main. Proč jsi nepoužila postup, který jsi mě naučila? Víš, ten s větvemi pro funkce.

Mara: Mohli jsme to udělat. Někdy ale lidé mění jenom soubor README nebo jiné soubory dokumentace, potvrdí se main správně. Kromě toho jsme ty a já tuto změnu před sloučením společně ověřili.

Ale to nás přivádí k dobrému bodu. Pokud se všichni můžeme jen potvrdit, main když chceme, můžeme nechat problémy v kódu vyklouznout do naší main větve.

Andy: Chtěl jsem s tebou mluvit o tom.

Andy a Mara pokračují v této konverzaci na cestě zpátky do svých kanceláří.