GitHub Actions je výkonný nástroj, který vám umožňuje automatizovat různé úkoly v procesu vývoje softwaru. Umožňují vám provádět skripty, testování, sestavení a nasazení vašeho kódu v úložišti. Mohou být použity ke zjednodušení procesu vývoje a zlepšení kvality kódu.
Chcete-li povolit Actions ve svém úložišti na Githubu, musíte vytvořit soubor "main.yml " ve složce .github / workflows vašeho úložiště. V tomto souboru definujete řadu úkolů, které chcete provést, když se spustí události ve vašem úložišti, jako je vytváření, změna nebo mazání pool Records, commitů nebo značek.
Soubor main.yml by měl být napsán ve značkovacím jazyce YAML, který umožňuje definovat Váš pracovní postup pro GitHub Actions. V souboru můžete identifikovat různé kroky a kroky, které budou provedeny, když se vaše událost spustí. Můžete například definovat kroky k sestavení projektu, spuštění testů nebo nasazení kódu.
Po vytvoření souboru main.yml a přidali definici vašeho pracovního postupu, Actions automaticky čte a provádí vaše akce, když jsou spuštěny příslušné události. Provedení vašich akcí můžete zkontrolovat na kartě Actions na stránce úložiště. Tam budete moci vidět historii provádění všech vašich akcí, stejně jako podrobné hlášení a protokoly provádění.
Nastavení Nastavení
Chcete-li aktivovat actions ve svém úložišti na Githubu, musíte provést několik jednoduchých kroků:
1. Přejděte na stránku úložiště na Githubu a v horní navigační liště vyberte sekci "Actions".
2. Klikněte na tlačítko "Set up a workflow yourself" nebo vyberte jednu z předem vytvořených šablon.
3. Vytvořte soubor s konfigurací actions, pojmenujte jej."github/workflows/main.yml " a přidejte akce, které chcete, do tohoto souboru. Například:
name: CIon:push:branches:- mainjobs:build:runs-on: ubuntu-lateststeps:- name: Checkout repositoryuses: actions/checkout@v2- name: Install dependenciesrun: npm install- name: Run testsrun: npm test- name: Buildrun: npm run build- name: Deploy to productionuses: actions/aws@v2with:accessKeyId: $>secretAccessKey: $>region: us-east-1bucket: my-bucket4. Uložte soubor a uložte jej do úložiště na Githubu.
Nyní je vaše úložiště nakonfigurováno pro použití actions. GitHub automaticky provede sadu akcí, které zadáte, když provedete určité události, jako je načtení zbraně v úložišti nebo vytvoření požadavku na pull.
Tvorba workflows
Chcete-li vytvořit workflow, musíte vytvořit soubor s názvem name.yml ve složce .github / workflows vašeho úložiště. Soubor musí obsahovat informace o událostech, které musí workflow spustit, a seznam akcí, které mají být provedeny.
Níže je uveden příklad jednoduchého workflow:
name: můj první workflow on: push: branches: - main jobs: build: runs-on: ubuntu-latest steps: - name: Checkout úložiště uses: actions / checkout@v2-name: instalace závislostí run: npm install-name: sestavení projektu run: npm build-name: spuštění testů run: npm test
V tomto příkladu je workflow zapojen při každém push do větve main. Provádí kroky , jako je kontrola úložiště pomocí akce actions/checkout, instalace závislostí, sestavení projektu a spuštění testů.
Po vytvoření souboru workflow, GitHub jej automaticky spustí, když dojde k odpovídajícím událostem. Budete moci sledovat průběh běhu workflow a také zobrazit logy a výsledky provádění akcí na kartě Actions vašeho úložiště.
Vytváření workflows je výkonný nástroj pro automatizaci vývojových procesů ve vašem projektu na Githubu. Pomohou vám zjednodušit pracovní postup, urychlit vývoj a zvýšit kvalitu vašeho kódu.
Formování událostí
Událost může být zpracována speciálním skriptem zvaným "Workflow". Workflow je sada instrukcí, které se provádějí, když dojde k určité události. Popisuje, jaké úkony je třeba provést a v jakém pořadí.
Tvorba událostí se provádí vytvořením souboru " workflow "ve speciálním adresáři".github " zásadně repozitář. V tomto souboru uvádíme, které události budou zpracovány, které akce mají být provedeny, a další možnosti. Jakmile je soubor workflow vytvořen a uložen, GitHub jej automaticky detekuje a začne zpracovávat události v něm uvedené.
V souboru workflow můžeme zadat různé možnosti, jako je název workflow, události, ve kterých má být provedeno, podmínky, za kterých má být provedeno, a další. Můžeme také zadat seznam akcí, které mají být provedeny, když dojde k události. Pro každou akci lze zadat různé možnosti a nastavení, jako jsou příkazy, které mají být provedeny, jejich pořadí, proměnné prostředí a další.
Formování událostí tedy zahrnuje vytvoření souboru workflow s uvedením požadovaných parametrů a akcí, které musí být provedeny. Poté GitHub automaticky zachytí uvedené události a provede akce popsané v workflow.
Použití environment
GitHub Actions umožňuje ovládat prostředí, ve kterém jsou akce prováděny. To je užitečné, když potřebujete zkontrolovat a spravovat podmínky provádění kódu na základě různých faktorů, jako je operační systém, jazyková verze, nainstalovaný software a další.
Prostředí je definováno pomocí souboru environment.yml, který by měl být ve vašem úložišti. V tomto souboru můžete zadat všechny požadované závislosti a nastavení pro Vaši akci. Můžete například zadat požadovanou verzi programovacího jazyka, nainstalovat konkrétní software nebo nakonfigurovat proměnné prostředí.
Příklad souboru environment.yml:
name: Pythonchannels:- conda-forgedependencies:- python=3.8- numpyV tomto příkladu je soubor environment.yml nastaví prostředí s názvem "Python", kde bude použit kanál" conda-forge " a budou nainstalovány balíčky Python verze 3.8 a numpy.
Prostředí definované v souboru environment.yml, lze použít v činnostech pomocí klíčového slova "env". Například:
steps:- name: Set up Python environmentuses: actions/setup-python@v2with:python-version: '3.8'env:PYTHONPATH: $>/srcV tomto příkladu je prostředí Pythonu 3.8 je nainstalován pomocí akce "actions / setup-python@v2". Proměnná prostředí PYTHONPATH je také nastavena tak, aby indikovala cestu ke složce "src" v pracovním adresáři úložiště.
Použití prostředí pomáhá vytvářet flexibilnější a všestrannější akce, které mohou fungovat v různých prostředích a prostředí.
Jak nastavit rauting
Chcete-li nastavit rauting v GitHub Actions, budete muset vytvořit soubor s nastavením rautingu. Tento soubor bude obsahovat informace o tom, které akce by měly být provedeny v reakci na určité události.
1. Vytvořte nový soubor v kořenové složce úložiště a pojmenujte jej .github/workflows/routing.yml . Můžete si vybrat jakýkoli jiný název, ale je důležité, aby byl soubor ve složce .github/workflows/ .
2. Otevřete vytvořený soubor v editoru kódu a zadejte následující kód:
name: Routingon:push:branches:- mainpull_request:branches:- main
V tomto příkladu jsme nastavili rauting pro události push a pull_request pouze pro větev main . Rauting můžete nakonfigurovat pro jakékoli další události a větve přidáním do příslušných sekcí.
3. Po konfiguraci událostí a větví, můžete přidat akce, které mají být provedeny. Můžete například přidat akci k provádění testů, sestavení projektu a nasazení na serveru:
jobs:test:runs-on: ubuntu-lateststeps:- name: Checkout codeuses: actions/checkout@v2- name: Run testsrun: npm testbuild:runs-on: ubuntu-latestneeds: teststeps:- name: Checkout codeuses: actions/checkout@v2- name: Build projectrun: npm run builddeploy:runs-on: ubuntu-latestneeds: buildsteps:- name: Checkout codeuses: actions/checkout@v2- name: Deploy to serverrun: ssh deploy@server 'cd /path/to/project && git pull'
V tomto příkladu jsme vytvořili tři akce: test, build a deploy . Budou provedeny postupně v reakci na události push a pull_request ve větvi main . Akce test provede testování kódu, akce build provede sestavení projektu a akce deploy rozbalí Projekt na serveru.
4. Uložte změny do souboru routing.yml a zakomponujte je do svého úložiště na Githubu.
Nyní je váš rauting nakonfigurován a automaticky se spustí v reakci na určité události. Akce ve vašem souboru rautingu můžete přidávat a upravovat podle vašich potřeb.
Práce s tajemstvím
Při práci s Adblock Actions v GitHubu, můžete použít tajemství k uložení citlivých informací, jako jsou hesla, tokeny API nebo přístupové klíče k databázím.
Tajemství jsou zašifrovaná data, která jsou přístupná pouze vašemu účtu a nelze je prohlížet ani měnit jinými účastníky projektu.
Chcete-li používat tajemství ve vašem workflow, musíte je přidat do Nastavení Úložiště. Chcete-li to provést, přejděte do úložiště, vyberte sekci Nastavení a poté přejděte na kartu tajemství.
Na stránce nastavení tajemství můžete přidat novou tajnou hodnotu zadáním jejího názvu a hodnoty. Po uložení budou tajné hodnoty dostupné ve vašem workflow jménem.
Chcete-li použít tajemství, přidejte jeho název do souboru workflow obklopeného dvojitými závorkami. Pokud jste například k použití v workflow přidali tajemství s názvem "API_TOKEN", můžete použít následující syntaxi:
steps:- name: Example steprun: echo $>To vám umožní použít hodnotu tajemství ve vašem workflow, aniž byste museli explicitně specifikovat jeho hodnotu v souboru.