Implementare variabili e script in un flusso di lavoro

Completato

Ora che si conoscono i componenti di un file del flusso di lavoro, è possibile esplorare come personalizzare questi flussi di lavoro per diversi scenari. In questa unità verrà illustrato come usare variabili e script per ottimizzare il flusso di lavoro. Le variabili consentono di archiviare e riutilizzare informazioni di configurazione senza distinzione tra maiuscole e minuscole. È possibile archiviare qualsiasi dato di configurazione, ad esempio flag del compilatore, nomi utente o nomi del server come variabili. Le variabili vengono interpolate nel computer di esecuzione che esegue il flusso di lavoro. I comandi eseguiti in azioni o passaggi del flusso di lavoro possono creare, leggere e modificare variabili.

È possibile impostare variabili personalizzate o usare le variabili di ambiente predefinite impostate automaticamente da GitHub. È possibile creare una variabile personalizzata in due modi.

  • Per definire una variabile di ambiente da usare in un singolo flusso di lavoro, è possibile usare la chiave env nel file del flusso di lavoro.
  • Per definire una variabile di configurazione in più flussi di lavoro, è possibile definirla a livello di organizzazione, repository o ambiente.

Definire le variabili di ambiente per un singolo flusso di lavoro

Per impostare una variabile di ambiente personalizzata per un singolo flusso di lavoro, è possibile definirla usando la chiave env nel file del flusso di lavoro. L'ambito di una variabile personalizzata impostata da questo metodo è limitato all'elemento in cui è definito. È possibile definire variabili con uno specifico ambito:

  • L'intero flusso di lavoro, utilizzando env al livello superiore del file del flusso di lavoro.
  • I contenuti di un processo all'interno di un flusso di lavoro, tramite jobs.<job_id>.env.
  • Un passaggio specifico all'interno di un processo, tramite jobs.<job_id>.steps[*].env.

Nota

Sia jobs.<job_id>.env che jobs.<job_id>.steps[*].env implementano contesti trattati più avanti in questo modulo.

L'esempio di flusso di lavoro seguente implementa due variabili, DAY_OF_WEEK e Greeting per produrre un messaggio di saluto quando viene eseguito.

name: Greeting on variable day

on:
  workflow_dispatch

env:
  DAY_OF_WEEK: Monday

jobs:
  greeting_job:
    runs-on: ubuntu-latest
    env:
      Greeting: Hello
    steps:
      - name: "Say Hello"
        run: echo "$Greeting, today is $DAY_OF_WEEK!"

Convenzioni di denominazione per le variabili di ambiente

Quando si imposta una variabile di ambiente, non è possibile usare alcun nome di variabile di ambiente predefinito. Se si tenta di eseguire l'override del valore di una di queste variabili predefinite, l'assegnazione viene ignorata.

Suggerimento

Per un elenco completo delle variabili di ambiente predefinite, vedere Variabili di ambiente predefinite.

Creare variabili di configurazione per un repository

Per creare segreti o variabili in GitHub per un repository di account personali, è necessario essere il proprietario del repository. Per creare segreti o variabili in GitHub per un repository dell'organizzazione, è necessario avere accesso admin. Infine, per creare segreti o variabili per un repository di account personali o un repository dell'organizzazione tramite l'API REST, è necessario disporre dell'accesso ai collaboratori.

Precedenza delle variabili di configurazione

Se una variabile con lo stesso nome esiste a più livelli, la variabile al livello più basso ha la precedenza. Ad esempio, se una variabile a livello di organizzazione ha lo stesso nome di una variabile a livello di repository, la variabile a livello di repository ha la precedenza. Analogamente, se un'organizzazione, un repository e un ambiente hanno una variabile con lo stesso nome, la variabile a livello di ambiente ha la precedenza.

Aggiungere script al flusso di lavoro

È possibile usare un flusso di lavoro di GitHub Actions per eseguire script e comandi della shell, che vengono quindi eseguiti nello strumento di esecuzione assegnato. Nell'esempio seguente viene illustrato come usare la parola chiave run per eseguire il comando npm install -g bats sul runner.

jobs:
  example-job:
    runs-on: ubuntu-latest
    steps:
      - run: npm install -g bats

Per eseguire uno script archiviato nel repository, è necessario prima eseguire il checkout dal repository allo strumento di esecuzione. Nell'esempio seguente: viene estratto il repository, impostata la directory di lavoro (il percorso degli script nel repository) ed eseguito lo script my-script.sh.

jobs:
  example-job:
    runs-on: ubuntu-latest
    defaults:
      run:
        working-directory: ./scripts
    steps:
      - name: Check out the repository to the runner
        uses: actions/checkout@v4  
      - name: Run a script
        run: ./my-script.sh

Tutti gli script che vuoi vengano eseguiti da un processo del flusso di lavoro devono essere eseguibili. È possibile passare lo script come argomento all'interprete che esegue lo script, ad esempio run: bash script.sh , oppure rendendo eseguibile il file stesso.