GitHub Actions je spolehlivý a výkonný automatizovaný nástroj, který vám pomůže zlepšit efektivitu vývoje a urychlit proces nasazení vašeho projektu na GitHub.
Instalace a použití GitHub Actions je velmi jednoduché a intuitivní i pro začátečníky. Chcete-li začít, vytvořte úložiště na Githubu a přejděte na kartu "Actions" v horní části stránky.
GitHub Actions nabízí široké možnosti pro vytváření vlastních pracovních postupů, které lze provádět v reakci na různé události nebo plány a integrovat se s jinými nástroji a službami.
Instalace GitHub Actions
Před zahájením používání GitHub Actions musíte nainstalovat a nakonfigurovat více komponent:
- Vytvořte si účet na Githubu, pokud jej ještě nemáte.
- Vytvořte úložiště na Githubu, kde bude váš kód uložen.
- Nainstalujte a nakonfigurujte Git, pokud jej ještě nemáte, abyste mohli lokálně pracovat s úložištěm.
- Skloňte úložiště do svého místního počítače pomocí příkazu git clone .
Po provedení těchto kroků jste připraveni začít používat GitHub Actions. Dále budete muset vytvořit konfigurační soubor pro svůj workflow.
Vytvořte soubor s názvem .github/workflows/build.yml v kořenovém adresáři vašeho úložiště. Tento soubor bude obsahovat pokyny pro GitHub Actions, jak shromažďovat a testovat váš kód.
Konfigurační soubor by měl být napsán v jazyce YAML a obsahovat seznam kroků, které GitHub Actions provede, když se spustí workflow.
Zde je příklad jednoduchého konfiguračního souboru, který sestavuje a testuje projekt:
name: Build and Teston:push:branches:- mainjobs:build:runs-on: ubuntu-lateststeps:- name: Checkout repositoryuses: actions/checkout@v2- name: Set up Node.jsuses: actions/setup-node@v2with:node-version: 14- name: Install dependenciesrun: npm install- name: Buildrun: npm run build- name: Testrun: npm test
Jakmile vytvoříte konfigurační soubor a přidáte jej do úložiště GitHub Actions, automaticky se spustí operace push do větve main. Workflow můžete nakonfigurovat pro jiné události, jako je vytvoření požadavku na pull nebo vytvoření nové značky změnou souboru .github/workflows/build.yml .
Kroky instalace a nastavení
Chcete-li začít používat GitHub Actions, musíte postupovat podle následujících kroků:
- Otevřete úložiště na Githubu, ve kterém chcete používat Actions.
- Přejděte na kartu "Actions" v horní části stránky.
- Klikněte na tlačítko "Set up a workflow yourself" nebo vyberte jednu z navrhovaných šablon.
- Otevře se editor workflow souboru ve formátu YAML.
- Proveďte potřebné změny v souboru a nakonfigurujte svůj workflow.
- Uložte změny a zakomponujte soubor do úložiště.
- GitHub Actions bude automaticky spuštěn na každý push do větve uvedené v souboru workflow.
Nyní můžete konfigurovat a používat soubory workflow k automatizaci procesů ve vašem úložišti na Githubu.
Vytvoření prvního pracovního postupu
GitHub Actions vám umožňují vytvářet automatizované pracovní postupy pro vaše úložiště. V této části se seznámíme se základy tvorby prvního pracovního postupu.
1. Otevřete úložiště na Githubu a přejděte na kartu "Actions".
2. Klikněte na tlačítko "Set up a workflow yourself" nebo vyberte jednu z předdefinovaných šablon.
3. V editoru, který se otevře, zadejte název souboru pro Váš pracovní postup (například " main.yml").
4. Začněte psát kód svého pracovního postupu. Syntaxi YAML můžete použít k určení kroků, událostí a podmínek provádění.
5. Přidejte kroky, které by měly být provedeny ve vašem pracovním procesu. Mohou to být příkazy k sestavení projektu, spuštění automatických testů nebo nasazení aplikace.
6. Uveďte události, při kterých by měl být spuštěn Váš pracovní postup. Může to být například push do hlavní větve nebo vytvoření nového Pull Request.
7. Nastavte požadavky a podmínky pro spuštění pracovního postupu. Filtry můžete nastavit na základě změn určitých souborů nebo podmínek pro větve a značky.
8. Uložte změny a spusťte pracovní postup. Výsledky provádění budete moci vidět na kartě "Actions" vašeho úložiště.
To je všechno! Právě jste vytvořili svůj první pracovní postup pomocí GitHub Actions. Neváhejte experimentovat a přizpůsobit své procesy, abyste automatizovali svou práci a zvýšili efektivitu vašeho projektu.
Popis základních pojmů
Pro úplné pochopení GitHub Actions je důležité seznámit se se základními pojmy, které se v tomto systému používají. Níže uvedená tabulka poskytuje základní pojmy a jejich popis:
| Termín | Popis |
|---|---|
| Workflow | Jedná se o automatizovaný proces, který se skládá z jednoho nebo více kroků. Workflow se provádí za určitých podmínek a lze jej nakonfigurovat tak, aby prováděl různé operace. |
| Action | Jedná se o univerzální blok kódu nebo skript, který se provádí uvnitř Workflow. Akce mohou být předem vytvořené nebo vytvořené komunitou. |
| Runner | Jedná se o virtuální nebo fyzický stroj, na kterém se Workflow provádí. GitHub poskytuje předinstalované Runner pro různé operační systémy. |
| Job | Je to jednotka práce, která se skládá z jednoho nebo více kroků. Job se provádí na jednom Runneru a může obsahovat úkoly k provedení. |
| Step | Jedná se o individuální akci, která se provádí uvnitř Job. Kroky mohou provádět různé příkazy, aktualizovat prostředí a další. |
| Event | Je to událost, která iniciuje spuštění Workflow. Událost může souviset s akcemi v úložišti GitHub, jako je vytvoření větve nebo vystavení hvězdičky. |
Seznámení se s těmito základními pojmy vám pomůže vytvořit a nakonfigurovat vlastní Workflow pomocí GitHub Actions.
Vytváření a úpravy pracovního postupu
GitHub Actions poskytuje možnost vytvářet a konfigurovat pracovní postupy, které automatizují úkoly ve vašem úložišti. Vytvoření nového pracovního postupu:
- Přejděte do úložiště na Githubu a otevřete kartu "Actions".
- Klikněte na tlačítko "Set up a workflow yourself" nebo vyberte šablonu vhodnou pro váš projekt.
- Otevře se soubor YAML, ve kterém můžete definovat kroky a události pro Váš pracovní postup.
- V případě potřeby změňte název souboru a identifikujte událost, která by měla spustit Váš pracovní postup.
- Určete kroky, které by měly být provedeny ve vašem pracovním procesu. Každý krok se skládá z názvu a akce a dalších parametrů, jako jsou podmínky provádění.
- Uložte soubor YAML a zakomponujte jej do úložiště.
- GitHub Actions začne provádět Váš pracovní postup, pokud dojde k určité události, kterou jste zadali.
Stávající pracovní postupy můžete také upravit na kartě "Actions". Kliknutím na název procesu otevřete jeho soubor YAML a proveďte požadované změny. Po uložení změn GitHub automaticky aktivuje aktualizovaný pracovní postup.
Přidání akcí do vašeho pracovního postupu
GitHub Actions vám umožňuje přidat různé akce do vašeho pracovního postupu, abyste zautomatizovali vývojové procesy a usnadnili práci vašeho týmu.
Akce v GitHub Actions mohou zahrnovat spouštění skriptů, sestavení a nasazení aplikací, testování kódu, odesílání oznámení, aktualizaci dokumentace a další.
Chcete-li přidat akci do pracovního postupu, musíte ve svém úložišti GitHub vytvořit soubor workflow. Tento soubor obsahuje popis vašeho pracovního postupu a určuje, které kroky by měly být provedeny.
K vytvoření akce můžete použít existující akce z GitHub Marketplace nebo si vytvořit vlastní akci. Akce z Marketplace jsou prezentovány různými nástroji a službami, které mohou být užitečné ve vašem pracovním procesu.
Když přidáte akci do svého pracovního postupu, označíte určité události, při kterých má být tato akce spuštěna. Můžete například nakonfigurovat pracovní postup tak, aby pokaždé, když někdo vytvoří novou větev ve vašem úložišti, bylo automaticky provedeno požadované sestavení a nasazení.
GitHub Actions také podporuje možnost práce se závislostmi, ukládání do mezipaměti a možnost paralelního provádění. To umožňuje efektivnější využití zdrojů a zvyšuje produktivitu vašeho pracovního postupu.
Abyste zajistili bezpečnost a ochranu úložiště, musíte nakonfigurovat přístupy, autentizaci a oprávnění pro vaše pracovní postupy. Tajemství Githubu můžete použít k ukládání citlivých informací, jako jsou autorizační údaje.
Přidání akcí do vašeho pracovního postupu vám umožní urychlit a zlepšit vývojový proces, nastavit automatické sestavení, testování a nasazení a usnadnit týmovou spolupráci.
Výběr akcí z knihovny
GitHub Actions poskytuje rozsáhlou knihovnu veřejných akcí, které lze použít ve vašem pracovním toku. Tyto akce jsou předem nakonfigurované kroky, které mohou být zahrnuty do pracovního toku a provádět různé úkoly.
Můžete vyhledávat akce v knihovně podle klíčových slov nebo kategorií a najít potřebné nástroje pro automatizaci vašich pracovních toků. Každá akce v knihovně má popis a příklady použití, díky čemuž je její výběr a použití jednodušší.
Jednou z hlavních výhod používání knihovny akcí je možnost vybrat si aktivity navržené komunitou. To znamená, že můžete použít práce a nástroje jiných vývojářů k urychlení a zjednodušení vlastních procesů. Když najdete akci, která vyhovuje vašim potřebám, můžete ji přidat do pracovního toku zadáním jejího názvu a další potřebné konfigurace.
Chcete-li použít akci z knihovny, musíte ji přidat do souboru s popisem pracovního toku ve vašem úložišti. To lze provést pomocí klíčového slova uses zadáním cesty k úložišti akce a verze , kterou chcete použít. Chcete-li například použít akci k sestavení výsledného artefaktu, můžete do souboru s popisem pracovního toku přidat následující řádek:
uses: actions/upload-artifact@v2
Toto je příklad použití akce upload-artifact, která umožňuje načíst soubory jako artefakty po spuštění pracovního toku. Můžete zadat verzi akce, abyste mohli použít konkrétní verzi , nebo použít klíčové slovo main, abyste vždy používali nejnovější verzi.
Výběr akcí z knihovny je silný způsob, jak automatizovat své pracovní toky a zjednodušit své vývojové procesy. Použitím předem nakonfigurovaných akcí a nástrojů poskytovaných komunitou vývojářů můžete výrazně zvýšit efektivitu a kvalitu vaší práce.
Konfigurace nastavení akcí
Chcete-li upravit nastavení akcí v GitHub Actions, můžete použít Soubor workflow YAML nebo je upravit na stránce akce na webu GitHub. Níže jsou uvedeny některé důležité možnosti, které lze nakonfigurovat pro Vaši akci:
- name: název vaší akce, která se zobrazí v protokolu provádění práce.
- on: událost, při které bude akce spuštěna. Například push, pull_request nebo schedule.
- env: proměnné prostředí, které budou k dispozici během provádění vaší akce. Můžete je použít k přenosu citlivých dat nebo nastavení do akce.
- with: vstupní parametry pro Vaši akci. Například název katalogu nebo verze softwaru.
- runs: příkaz nebo skript, který bude proveden během akce.
- if: podmínka, kdy bude akce spuštěna nebo vynechána. Můžete například nastavit podmínku na základě větve, značky nebo hodnoty proměnné prostředí.
- needs: seznam dalších akcí, které musí být provedeny před provedením aktuální akce.
- timeout-minutes: maximální doba trvání akce v minutách. Pokud akce v tomto časovém období neskončí, bude zrušena.
Toto jsou pouze některé z možností, které lze nakonfigurovat pro akce v GitHub Actions. Dokumentaci k nastavení možností akcí můžete dále prozkoumat na webu GitHub.
Nahrání zdrojového kódu na GitHub
Než začnete používat GitHub Actions, je nutné stáhnout zdrojový kód vašeho projektu na server GitHub. Postupujte podle pokynů:
- Otevřete stránku úložiště na Githubu.
- Klikněte na tlačítko "Code" vedle názvu úložiště.
- Vyberte způsob načítání kódu. Archiv s kódem si můžete buď stáhnout kliknutím na" Download ZIP", nebo klonovat úložiště pomocí Git.
- Pokud se rozhodnete klonovat úložiště pomocí Git, zkopírujte adresu URL úložiště.
- Otevřete terminál v počítači a spusťte příkaz " git clone [URL úložiště]"pro klonování úložiště.
- Po úspěšném klonování úložiště můžete začít pracovat s kódem v počítači a provádět potřebné změny.
Po stažení zdrojového kódu na GitHub jste připraveni použít GitHub Actions k automatizaci vašeho pracovního postupu. Nyní můžete vytvářet a konfigurovat různé pracovní postupy, které se budou provádět pokaždé, když dojde k určitým událostem ve vašem úložišti.
Vytvoření úložiště
Než začnete používat GitHub Actions, musíte na Githubu vytvořit nové úložiště.
Chcete-li vytvořit úložiště, postupujte podle těchto kroků:
- Přejděte na github.com a přihlaste se ke svému účtu.
- Klikněte na tlačítko" Nový " (Nový) v pravém horním rohu stránky nebo přejděte na přímý odkaz https://github.com/new..
- Do pole "Repository name" (název úložiště) zadejte název nového úložiště.
- Vyberte si veřejné nebo soukromé úložiště podle svých potřeb.
- Volitelně přidejte popis pro své úložiště.
- Vyberte možnost "Initialize this repository with a README" (inicializovat toto úložiště s README) a vytvořte soubor README ve vašem úložišti.
- Kliknutím na tlačítko "Create repository" (vytvořit úložiště) dokončíte vytvoření.
Vaše nové úložiště je připraveno k použití s Github Actions! Nyní můžete konfigurovat a spouštět své vlastní pracovní postupy pro automatizaci různých úkolů ve vašem úložišti.
Přidání zdrojového kódu do úložiště
Chcete-li do úložiště přidat zdrojový kód, musíte nejprve vytvořit nové úložiště na platformě GitHub. Po vytvoření úložiště jej můžete klonovat do místního počítače pomocí příkazu Git. Můžete například použít následující příkaz:
git clone úložiště.git
Po klonování úložiště můžete svůj zdrojový kód přidat do místní kopie úložiště v počítači. Původní soubory můžete umístit do podsložek úložiště, aby byly logicky uspořádány.
Až budete hotovi s přidáním zdrojového kódu, můžete pomocí následujících příkazů přidat zdrojový kód do úložiště na Githubu:
git add . git commit-m "přidat zdrojový kód" git push origin master
Pokud používáte jiné jméno, můžete origin nahradit jménem svého vzdáleného úložiště.
Po provedení těchto příkazů bude váš zdrojový kód přidán do vašeho vzdáleného úložiště na Githubu. Nyní můžete pomocí GitHub Actions automatizovat různé úkoly na základě vašeho zdrojového kódu.
Spuštění pracovního procesu
Než začnete používat GitHub Actions, musíte vytvořit soubor workflow, který bude obsahovat pokyny k provádění určitých akcí.
1. Přejděte do úložiště na Githubu.
2. V části úložiště vyberte kartu "Actions".
3. Klikněte na tlačítko "New workflow" v pravém horním rohu obrazovky.
4. Vyberte šablonu pro vytvoření nového workflow nebo vytvořte prázdný soubor.
5. Zadejte název souboru workflow a vyberte událost, která jej spustí. Může to být například push do úložiště nebo vytvoření nového pull request.
6. Vyplňte soubor workflow příslušnými pokyny a kroky, které musí být provedeny v pracovním procesu.
7. Uložte soubor workflow do úložiště.
8. GitHub automaticky spustí pracovní postup, pokud jsou nakonfigurovány příslušné události.
Celkově je GitHub Actions velmi výkonný nástroj, který vám umožňuje automatizovat různé pracovní postupy ve vašem úložišti. S ním můžete vytvářet a spouštět vlastní workflow a také používat připravené šablony, které vám pomohou urychlit práci.