Foglio di riferimento per GitHub Actions - Struttura standard e elenco delle azioni più utili

GitHub Actions è una piattaforma di automazione e CI/CD all’interno di GitHub, utilizzata per costruire, testare e distribuire il tuo codice in base a eventi come push, richieste di pull o su un orario predefinito.

Oltre all’utilizzo standard di GitHub, puoi utilizzare GitHub Actions anche in un server Gitea self-hosted.

Questo riepilogo copre la struttura di GitHub Actions, una breve descrizione e le azioni più comuni utilizzate nei flussi di lavoro open source e commerciali. Le azioni coprono strumenti ufficiali, della comunità e di terze parti, supportando l’automazione da costruzioni e test alla distribuzione, gestione delle release, QA e notifiche.

Struttura di Configurazione Base

I workflow di GitHub Actions sono definiti in file YAML situati nella directory .github/workflows all’interno del repository.

name: Nome del Workflow
on:
  push:
    branches: [ main ]
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Configura Node.js
        uses: actions/setup-node@v3
        with:
          node-version: '18'
      - name: Esegui test
        run: npm test

• Il blocco on specifica gli eventi di attivazione.
• Ogni job viene eseguito su un proprio runner.
• steps possono eseguire comandi shell o chiamare azioni riutilizzabili.

Componenti Principali del Workflow

Eventi di Attivazione

• push
• pull_request
• schedule (utilizzando la sintassi cron)
• workflow_dispatch (attivazione manuale, consente parametri di input)
• release, issue, ecc.

Esempio:

on:
  push:
    branches: [ main ]
  workflow_dispatch:
    inputs:
      environment:
        description: 'Ambiente di distribuzione'
        required: true
        default: 'production'
        type: string

Azioni Utili Predefinite

Parametri delle Azioni

Parametri Generali per qualsiasi Chiamata di Azione:

- name: Alcuna Azione o Passo
  uses: owner/repo@ref
  with:
    param1: valore
    param2: valore
  env:
    ENV_VAR: valore
  if: ${{ condizione }}
  run: comando_da_eseguire
  shell: bash|pwsh|python|sh
  continue-on-error: true|false

• with: argomenti passati all’azione (vedi la documentazione dell’azione per tutte le opzioni)
• env: variabili ambiente per il passo
• if: esecuzione condizionale
• run: comandi shell (se non si utilizza un’azione)
• shell: shell utilizzata per eseguire il passo
• continue-on-error: procedi anche se il passo fallisce

Definizione di Input Personalizzati per un’Azioni

Nella metadata dell’azione (action.yml):

inputs:
  example-input:
    description: 'Un esempio di input'
    required: false
    default: 'default-value'

Quando utilizzato in un workflow:

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

Accessibile come variabile ambiente INPUT_EXAMPLE_INPUT quando l’azione viene eseguita.

Esempio: Workflow con Parametri Manuali

name: Deploy
on:
  workflow_dispatch:
    inputs:
      environment:
        description: 'Ambiente di distribuzione'
        required: true
        default: 'production'
        type: string
jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout del codice
        uses: actions/checkout@v4
      - name: Distribuisci nell'ambiente
        run: echo "Distribuendo a ${{ github.event.inputs.environment }}"

Mercato delle Azioni

• Disponibili migliaia di azioni riutilizzabili nel GitHub Marketplace.
• Le categorie includono: distribuzioni cloud, strumenti di notifica, framework di test, analisi del codice, e molto altro.
• Esplora: actions/checkout, actions/setup-node, docker/build-push-action, actions/cache, actions/upload-artifact, e molti altri.

Consigli Veloci

• Posiziona i file del workflow in .github/workflows.
• Utilizza workflow_dispatch con inputs per esecuzioni manuali e parametrizzate.
• Utilizza l’azione cache per velocizzare l’installazione delle dipendenze.
• Utilizza la matrice job per testare diverse versioni di OS/running.
• Utilizza i segreti per dati sensibili, riferiti come ${{ secrets.SECRET_NAME }}.

Questo riferimento copre gli elementi essenziali per utilizzare, configurare e estendere GitHub Actions per l’automazione, CI/CD e altro. Per maggiori dettagli e aggiornamenti, controlla sempre la documentazione ufficiale di GitHub e i repository delle azioni.

Azioni GitHub Comuni

Ecco un elenco pratico di azioni GitHub frequentemente utilizzate che aiutano ad automatizzare CI/CD, test, costruzione, distribuzione e compiti di workflow:

Azioni Ufficiali Principali

Azioni della Comunità e di Terze Parti Popolari

Azioni per Test, QA e Reporting

Azioni per Distribuzione e Notifica

Azioni di Utilità e Gestione dei Workflow

Come Trovare di Più

Esistono molte azioni di GitHub che abilitano l’automazione dei workflow come i test automatici, la distribuzione in produzione, le notifiche e le integrazioni con altri servizi. Il GitHub Marketplace elencano migliaia di azioni in categorie come test, sicurezza, distribuzione, notifiche, qualità del codice e integrazioni. Elenco curati come “Awesome Actions” sono anche ottimi per ispirazione e scoperta.

Link Utili

• 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
• GIT Cheatsheet
• Gitea - installazione e test
• Backup e ripristino del server Gitea
• Utilizzo di Gitea Actions per distribuire un sito Hugo ad AWS S3
• Gitflow: Passaggi, Alternative, Vantaggi e Svantaggi
• DevOps con GitOps - Argo CD, Flux, Jenkins X, Weave GitOps e altri