Správa akcí a pracovních postupů

Dokončeno

V této části prozkoumáte různé nástroje a strategie, které máte k dispozici v cloudu GitHub Enterprise a Na GitHub Enterprise Serveru, abyste mohli sdílet akce a pracovní postupy GitHubu a spravovat jejich použití v rámci vašeho podniku.

Obsah je strukturovaný kolem úrovně, na které jsou k dispozici nástroje, které jsou k dispozici: na podnikové úrovni nebo na úrovni organizace.

Na podnikové úrovni

Konfigurace zásad použití GitHub Actions

Pracovní postupy GitHub Actions často obsahují akce, které jsou sady samostatných příkazů, které se mají spustit v rámci pracovního postupu. Při vytváření pracovního postupu můžete vytvořit vlastní akce pro použití nebo odkazovat na akce veřejné komunity dostupné na GitHub Marketplace. Z tohoto důvodu je potřeba nakonfigurovat zásady použití pro pracovní postupy a akce ve vašem podniku, aby uživatelé nemohli používat škodlivé akce třetích stran.

V podnikovém cloudu máte několik možností, jak nakonfigurovat zásady, a také na Enterprise Serveru, pokud je v podnikových nastaveních povolená služba GitHub Connect.

Pokud chcete nakonfigurovat zásady použití GitHub Actions pro váš podnik, přejděte na podnikový účet a potom na bočním panelu na Akce zásad>. Měly by se zobrazit následující možnosti.

Rozevírací seznam v horní části s popiskem Povolit pro všechny organizace umožňuje rozhodnout se, které organizace ve vašem podniku můžou používat GitHub Actions (všechny z nich, některé z nich nebo žádné z nich), zatímco tři možnosti dole umožňují definovat úroveň omezení GitHub Actions v rámci těchto organizací.

Pokud chcete povolit, aby se v rámci vašeho podniku používaly jenom konkrétní akce, vyberte Povolit podnik a vyberte jiné než podnikové, akce a opakovaně použitelné pracovní postupy a zvolte možnost odpovídající vašemu případu použití.

Ruční synchronizace veřejných akcí pro podnikový server

Většina oficiálních akcí vytvořených na GitHubu se automaticky spojí s Enterprise Serverem a zachytí se v okamžiku z GitHub Marketplace. Patří mezi ně actions/checkout, , actions/upload-artifactactions/download-artifact, actions/labelera různé actions/setup- akce, mimo jiné. Pokud chcete získat všechny oficiální akce zahrnuté ve vaší podnikové instanci, přejděte do organizace akcí ve vaší instanci: https://HOSTNAME/actions.

Jak je uvedeno v části Konfigurace akce GitHub Actions, je možné nakonfigurovat Enterprise Server tak, aby automaticky přistupoval k veřejným akcím dostupným na GitHub Marketplace a nakonfiguroval pro ně zásady použití. Pokud ale chcete mít přísnější kontrolu nad veřejnými akcemi, které by se měly zpřístupnit ve vašem podniku, můžete akce do podnikové instance stáhnout a synchronizovat ručně pomocí nástroje actions-sync .

Na úrovni organizace

Zdokumentovat firemní standardy

Vytvoření pracovního postupu GitHub Actions často zahrnuje zápis více souborů a vytvoření několika úložišť pro určení samotného pracovního postupu. Vytváření zahrnuje také akce, kontejnery a/nebo spouštěče, které se mají použít v pracovním postupu. V závislosti na počtu uživatelů v instanci podnikového cloudu nebo podnikového serveru můžou být věci poměrně rychlé, pokud nemáte zavedené podnikové standardy pro vytváření pracovních postupů GitHub Actions.

Osvědčeným postupem je dokumentovat na wikiwebu GitHubu nebo jako soubor Markdownu v úložišti přístupném všem v rámci organizace:

• Úložiště
• Zásady vytváření názvů souborů a složek
• Umístění sdílených komponent
• Plány pro průběžnou údržbu
• Pokyny pro přispívání

Vytváření šablon pracovních postupů

Šablony pracovních postupů představují skvělý způsob, jak zajistit opakované použití a údržbu automatizace ve vašem podniku. V podnikovém cloudu i na podnikovém serveru můžou uživatelé s přístupem k zápisu do úložiště organizace .github vytvářet šablony pracovních postupů, které budou k dispozici členům jiné organizace se stejným přístupem pro zápis. Šablony pracovních postupů je pak možné použít k vytvoření nových pracovních postupů ve veřejných a privátních úložištích organizace.

Vytvoření šablony pracovního postupu se provádí ve dvou krocích:

1. Vytvořte yml soubor pracovního postupu.

2. Vytvořte json soubor metadat, který popisuje, jak má být šablona prezentována uživatelům při vytváření pracovního postupu.

   Poznámka:

   Soubor metadat musí mít stejný název jako soubor pracovního postupu. Místo přípony .yml musí být připojen s příponou .properties.json. Například soubor s názvem octo-organization-ci.properties.json obsahuje metadata pro soubor pracovního postupu s názvem octo-organization-ci.yml.

Oba soubory musí být umístěny ve veřejném .github úložišti a v adresáři s názvem workflow-templates. Možná je budete muset vytvořit, pokud ještě ve vaší organizaci neexistují.

Následuje příklad základního souboru pracovního postupu:

name: Octo Organization CI

on:
  push:
    branches: [ $default-branch ]
  pull_request:
    branches: [ $default-branch ]

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v2

      - name: Run a one-line script
        run: echo Hello from Octo Organization

Všimněte si, že předchozí soubor používá $default-branch zástupný symbol. Při vytvoření pracovního postupu pomocí šablony se tento zástupný symbol automaticky nahradí názvem výchozí větve úložiště.

Následuje soubor metadat, který byste vytvořili pro soubor pracovního postupu:

{
    "name": "Octo Organization Workflow",
    "description": "Octo Organization CI workflow template.",
    "iconName": "example-icon",
    "categories": [
        "Go"
    ],
    "filePatterns": [
        "package.json$",
        "^Dockerfile",
        ".*\\.md$"
    ]
}

Soubory metadat používají následující parametry:

Parametr	Popis	Povinní účastníci
name	Název šablony pracovního postupu zobrazené v seznamu dostupných šablon	Ano
description	Popis šablony pracovního postupu zobrazené v seznamu dostupnýchšablonch	Ano
iconName	Definuje ikonu pro položku pracovního postupu v seznamu šablon. Musí to být ikona SVG se stejným názvem a musí být uložená v adresáři workflow-templates . Například název souboru example-icon.svg SVG je odkazován jako example-icon.	No
categories	Definuje kategorii jazyka pracovního postupu. Když uživatel zobrazí dostupné šablony, budou šablony, které odpovídají stejnému jazyku, výrazněji používat.	No
filePatterns	Umožňuje použití šablony, pokud má úložiště uživatele v kořenovém adresáři soubor, který odpovídá definovanému regulárnímu výrazu.	No

Po vytvoření šablony pracovního postupu ji uživatelé ve vaší organizaci můžou najít v části Akce > Nové pracovní > postupy vytvořené _your_organization_name.