Cheat Sheet GitHub Actions – standardowa struktura i lista najbardziej przydatnych akcji

GitHub Actions jest platformą automatyzacji i CI/CD w ramach GitHub, używaną do budowania, testowania i wdrażania kodu na podstawie zdarzeń, takich jak push, żądania pull request lub harmonogram.

Oprócz standardowego GitHub możesz używać GitHub Actions na samodzielnie hostowanym serwerze Gitea.

Akcje obejmują narzędzia oficjalne, społecznościowe i сторонnie, wspierając automatyzację od budowania i testowania po wdrażanie, zarządzanie wydaniem, kontrolę jakości (QA) oraz powiadomienia.

To podsumowanie obejmuje strukturę GitHub Actions, krótki opis oraz najczęściej używane akcje w przepływach pracy open source i komercyjnych. Jest to część przewodnika Narzędzia dla programistów: Kompletny przewodnik po nowoczesnych przepływach pracy.

Podstawowa struktura konfiguracji

Przepływy pracy (Workflows) GitHub Actions są zdefiniowane w plikach YAML znajdujących się w katalogu .github/workflows wewnątrz repozytorium.

name: Workflow Name
on:
  push:
    branches: [ main ]
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Set up Node.js
        uses: actions/setup-node@v3
        with:
          node-version: '18'
      - name: Run tests
        run: npm test

• Blok on określa zdarzenia wyzwalające (triggery).
• Każda praca (job) wykonuje się na własnym runnerze.
• steps mogą wykonywać polecenia powłoki (shell) lub wywoływać ponownie używalne akcje.

Podstawowe składniki przepływu pracy

Zdarzenia wyzwalające

• push
• pull_request
• schedule (używając składni cron)
• workflow_dispatch (ręczne wyzwalanie, pozwala na parametry wejściowe)
• release, issue itp.

Przykład:

on:
  push:
    branches: [ main ]
  workflow_dispatch:
    inputs:
      environment:
        description: 'Deployment Environment'
        required: true
        default: 'production'
        type: string

Przydatne wbudowane akcje

Parametry akcji

Ogólne parametry dla dowolnego wywołania akcji:

- name: Some Action or Step
  uses: owner/repo@ref
  with:
    param1: value
    param2: value
  env:
    ENV_VAR: value
  if: ${{ condition }}
  run: command_to_run
  shell: bash|pwsh|python|sh
  continue-on-error: true|false

• with: argumenty przekazywane do akcji (zobacz dokumentację akcji dla wszystkich opcji)
• env: zmienne środowiskowe dla kroku
• if: warunkowe wykonanie
• run: polecenia powłoki (jeśli nie używa się akcji)
• shell: powłoka używana do wykonania kroku
• continue-on-error: kontynuuj nawet jeśli krok nie powiódł się

Definiowanie własnych parametrów wejściowych

W metadanych akcji (action.yml):

inputs:
  example-input:
    description: 'An example input'
    required: false
    default: 'default-value'

Podczas użycia w przepływie pracy:

- uses: my/action@v1
  with:
    example-input: 'custom-value'

Dostępne jako zmienna środowiskowa INPUT_EXAMPLE_INPUT podczas uruchamiania akcji.

Przykład: Przepływ pracy z ręcznymi parametrami

name: Deploy
on:
  workflow_dispatch:
    inputs:
      environment:
        description: 'Deployment Environment'
        required: true
        default: 'production'
        type: string
jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v4
      - name: Deploy to environment
        run: echo "Deploying to ${{ github.event.inputs.environment }}"

Rynek akcji (Action Marketplace)

• Tysiące ponownie używalnych akcji jest dostępnych na Rynku GitHub.
• Kategorie obejmują: wdrożenia w chmurze, narzędzia powiadomień, ramy testowe, analizę kodu i wiele więcej.
• Przeglądaj: actions/checkout, actions/setup-node, docker/build-push-action, actions/cache, actions/upload-artifact i wiele innych.

Szybkie wskazówki

• Umieść pliki przepływów pracy w .github/workflows.
• Użyj workflow_dispatch z inputs do ręcznych i parametrizowanych uruchomień.
• Użyj akcji cache, aby przyspieszyć instalację zależności.
• Użyj macierzy (matrix) jobów do testowania wielu wersji systemów operacyjnych i środowisk uruchamiania.
• Użyj sekretów (secrets) dla danych wrażliwych, odwoływanych jako ${{ secrets.SECRET_NAME }}.

Ten skrypt obejmuje podstawy używania, konfigurowania i rozszerzania GitHub Actions dla automatyzacji, CI/CD i więcej. Dla więcej szczegółów i aktualizacji zawsze sprawdzaj oficjalną dokumentację GitHub i repozytoria akcji.

Popularne akcje GitHub

Oto praktyczna lista często używanych akcji GitHub, które pomagają w automatyzacji CI/CD, testowaniu, budowaniu, wdrażaniu i zadaniach przepływu pracy:

Podstawowe oficjalne akcje

Popularne akcje społecznościowe i сторонnie

Akcje do testowania, QA i raportowania

Akcje do wdrażania i powiadomień

Narzędzia i zarządzanie przepływem pracy

Jak znaleźć więcej

Istnieje wiele akcji GitHub, które umożliwiają automatyzację przepływów pracy, takich jak automatyzacja testów, wdrożenia na produkcję, powiadomienia i integracje z innymi usługami. Rynek GitHub wymienia tysiące akcji w kategoriach takich jak testowanie, bezpieczeństwo, wdrażanie, powiadomienia, jakość kodu i integracje. Kuratorowane listy, takie jak “Awesome Actions”, są również świetne do inspiracji i odkrywania nowych rozwiązań.

Przydatne linki

• https://docs.github.com/actions
• https://github.com/marketplace
• https://docs.github.com/en/actions/get-started/quickstart
• https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions
• Skróty Git
• Gitea - instalacja i testowanie
• Kopia zapasowa i przywracanie serwera Gitea
• Używanie Gitea Actions do wdrażania strony Hugo na AWS S3
• Gitflow: Kroki, alternatywy, zalety i wady
• DevOps z GitOps - Argo CD, Flux, Jenkins X, Weave GitOps i inne