Esplora contesti ed espressioni in GitHub
I contesti sono un modo per accedere alle informazioni sulle esecuzioni del flusso di lavoro, le variabili, gli ambienti di esecuzione, i processi e i passaggi. Ogni contesto è un oggetto che contiene proprietà, che possono essere stringhe o altri oggetti.
È possibile accedere ai contesti usando la sintassi dell'espressione. Un'espressione può essere qualsiasi combinazione di valori letterali, riferimenti a un contesto o funzioni. È possibile combinare valori letterali, riferimenti di contesto e funzioni usando gli operatori.
Contesti
Quando si creano flussi di lavoro e azioni, è consigliabile considerare sempre se il codice potrebbe eseguire input non attendibile da possibili utenti malintenzionati. Alcuni contesti devono essere considerati come input non attendibili, in quanto un utente malintenzionato potrebbe inserire il proprio contenuto dannoso. Per altre informazioni, vedere Protezione avanzata della sicurezza per GitHub Actions."
La tabella seguente contiene esempi di contesti disponibili in GitHub e non è un elenco completo.
| Nome contesto | TIPO | Descrizione |
|---|---|---|
github |
object |
Informazioni sull'esecuzione del flusso di lavoro. |
env |
object |
Contiene le variabili impostate in un flusso di lavoro, un processo o un passaggio. |
vars |
object |
Contiene variabili impostate a livello di repository, organizzazione o ambiente. |
job |
object |
Informazioni sul processo attualmente in esecuzione. |
Suggerimento
Per un elenco completo dei contesti, vedere Informazioni sui contesti.
Determinazione del momento in cui usare i contesti
GitHub Actions include due raccolte di variabili denominate variabili e contestipredefiniti. Queste variabili sono destinate all'uso in punti diversi nel flusso di lavoro:
- Variabili di ambiente predefinite: queste variabili di ambiente esistono solo nello strumento di esecuzione che esegue il processo.
- Contesti: è possibile usare la maggior parte dei contesti in qualsiasi punto del flusso di lavoro, incluso quando le variabili predefinite non sono disponibili.
Nell'esempio seguente l'istruzione if controlla il github.ref contesto per determinare il nome del ramo corrente. Il if controllo viene elaborato e il processo viene inviato allo strumento di esecuzione solo se il risultato è true. Dopo che il processo viene inviato allo strumento di esecuzione, il passaggio viene eseguito e fa riferimento alla $GITHUB_REF variabile dello strumento di esecuzione.
name: CI
on: push
jobs:
prod-check:
if: ${{ github.ref == 'refs/heads/main' }}
runs-on: ubuntu-latest
steps:
- run: echo "Deploying to production server on branch $GITHUB_REF"
Contesti disponibili in GitHub Actions
La tabella seguente contiene i contesti di primo livello disponibili, una breve descrizione e un collegamento per altre informazioni sulle proprietà dell'oggetto.
| Contesto di primo livello | Descrizione | Proprietà ed esempi |
|---|---|---|
github |
Contesto di primo livello disponibile durante qualsiasi processo o passaggio in un flusso di lavoro. |
Proprietà del github contesto. |
env |
Contiene le variabili impostate in un flusso di lavoro, un processo o un passaggio. Non contiene variabili ereditate dal processo di esecuzione. |
Proprietà del env contesto. |
vars |
Contiene variabili di configurazione personalizzate impostate a livello di organizzazione, repository e ambiente. |
Esempi di vars utilizzo. |
job |
Contiene informazioni sul processo attualmente in esecuzione. |
Proprietà del job contesto. |
jobs |
Disponibile solo nei flussi di lavoro riutilizzabili e può essere usato solo per impostare gli output per un flusso di lavoro riutilizzabile. |
Proprietà del jobs contesto. |
steps |
Contiene informazioni sui passaggi completati nel processo corrente con un id oggetto specificato. |
Proprietà del steps contesto. |
runner |
Contiene informazioni sullo strumento di esecuzione che esegue il processo corrente. |
Proprietà del runner contesto. |
secrets |
Contiene i nomi e i valori dei segreti disponibili per l'esecuzione di un workflow. |
Proprietà del secrets contesto. |
strategy |
Contiene informazioni sulla strategia di esecuzione della matrice per il processo corrente. |
Proprietà del strategy contesto. |
matrix |
Contiene le proprietà della matrice definite nel file del flusso di lavoro che si applicano al processo corrente. |
Proprietà del matrix contesto. |
needs |
Contiene output di tutti i processi definiti come dipendenza diretta del processo corrente. |
Proprietà del matrix contesto. |
inputs |
Contiene proprietà di input passate a un'azione, a un flusso di lavoro riutilizzabile o a un flusso di lavoro attivato manualmente. |
Proprietà del inputs contesto. |
Espressioni
È possibile usare le espressioni per impostare le variabili di ambiente a livello di codice nei file del flusso di lavoro e nei contesti di accesso. Un'espressione può essere qualsiasi combinazione di valori letterali, riferimenti a un contesto o funzioni. È possibile combinare valori letterali, riferimenti di contesto e funzioni usando gli operatori.
Le espressioni vengono comunemente usate con la parola chiave condizionale if in un file del flusso di lavoro per determinare se deve essere eseguito un passaggio. Quando un'istruzione if condizionale è true, il passaggio viene eseguito.
È necessario usare una sintassi specifica, ${{ <expression> }}, per indicare a GitHub di valutare un'espressione anziché considerarla come stringa. L'eccezione a questa regola è quando si usano espressioni in una if clausola , in cui in genere possono essere omessi ${{ e }}.
Nell'esempio di codice seguente viene illustrata l'impostazione di una variabile di ambiente.
env:
MY_ENV_VAR: ${{ <expression> }}
Valori letterali
Come parte di un'espressione, è possibile usare booleani tipi di dati , nullnumber, o string . Nelle istruzioni condizionali, i valori falsi (false, 0, -0"", '', , null) sono coerciti a false e verità (true e altri valori non falsi) vengono coerciti a true. Di seguito sono illustrati esempi di implementazione di valori letterali.
env:
myNull: ${{ null }}
myBoolean: ${{ false }}
myIntegerNumber: ${{ 711 }}
myFloatNumber: ${{ -9.2 }}
myHexNumber: ${{ 0xff }}
myExponentialNumber: ${{ -2.99e-2 }}
myString: Mona the Octocat
myStringInBraces: ${{ 'It''s open source!' }}
Operatori
Gli operatori svolgono un ruolo fondamentale nella valutazione delle espressioni. Un'espressione può essere costituita da valori letterali, riferimenti a contesti o funzioni. Gli operatori consentono di combinare questi elementi per creare espressioni più complesse. Ecco alcuni operatori chiave:
Operatori logici:
-
&&(e): combina due condizioni, entrambe vere affinché l'espressione complessiva restituisca true. -
||(o): combina due condizioni e l'espressione restituisce true se una delle due condizioni è true. -
!(not): nega una condizione, capovolgendone il valore di verità.
-
Operatori di uguaglianza:
-
==(uguale): confronta due valori per verificare l'uguaglianza. -
!=(diverso da): controlla se due valori non sono uguali.
-
Operatori di confronto:
-
<(minore di) -
>(maggiore di) -
<=(minore o uguale a) -
>=(maggiore o uguale a)
-
Questi operatori consentono di creare flussi di lavoro dinamici determinando quando eseguire passaggi specifici in base alle condizioni. Ricordarsi di usare la sintassi corretta per le espressioni, ad esempio $\{\{ <expression> \}\}$, per garantire una valutazione corretta.
Per altre informazioni sugli operatori, vedere Operatori.