Variáveis

Sobre variáveis

Você pode usar variáveis para armazenar informações que deseja referenciar no seu fluxo de trabalho. Você faz referência a variáveis em uma etapa do fluxo de trabalho ou em uma ação, e as variáveis são interpoladas na máquina que executa seu fluxo de trabalho. Os comandos que são executados em ações ou etapas do fluxo de trabalho podem criar, ler e modificar variáveis.

Você pode definir variáveis personalizadas próprias, usar as variáveis padrão que o GitHub define automaticamente, ou ainda usar qualquer outra variável definida no ambiente de trabalho do executor. As variáveis diferenciam maiúsculas de minúsculas.

Definindo variáveis de ambiente

Ao definir uma variável de ambiente personalizada, é possível faze-lo usando a chave env do arquivo do fluxo de trabalho. O escopo de uma variável personalizada definida por este método fica limitado ao elemento em que ele está definido. Você pode definir variáveis cujos escopos são definidos como:

• Todo o fluxo de trabalho, usando env no nível superior do arquivo de fluxo de trabalho.
• O conteúdo de um trabalho em um fluxo de trabalho, usando jobs.<job_id>.env.
• Uma etapa específica em um trabalho, usando jobs.<job_id>.steps[*].env.

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 Mona it's Monday"
        run: echo "$Greeting $First_Name. Today is $DAY_OF_WEEK!"
        env:
          First_Name: Mona

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 Mona it's Monday"
        run: echo "$Greeting $First_Name. Today is $DAY_OF_WEEK!"
        env:
          First_Name: Mona

Você pode acessar env valores de variáveis usando as variáveis de ambiente do executor ou usando contextos. O exemplo acima mostra três variáveis personalizadas usadas como variáveis de ambiente de executor em um comando echo: $DAY_OF_WEEK, $Greeting e $First_Name. Os valores e os escopos dessas variáveis são definidos no nível do fluxo de trabalho, do trabalho e da etapa, respectivamente. A interpolação dessas variáveis acontece no executor.

Os comandos nas etapas run de um fluxo de trabalho, ou uma ação referenciada, são processados pelo shell que você está usando no executor. As instruções nas outras partes de um fluxo de trabalho são processadas por GitHub Actions e não são enviadas para o executor. Você pode usar variáveis de ambiente do executor ou contextos em etapas run, mas, nas partes de um fluxo de trabalho que não são enviadas ao executor, você deve usar contextos para acessar valores de variáveis. Para obter mais informações, consulte "Usar contextos para acessar valores de variáveis".

Como a interpolação de variável de ambiente do executor é feita depois que um trabalho do fluxo de trabalho é enviado para uma máquina do executor, você deve usar a sintaxe apropriada para o shell usado no executor. Neste exemplo, o fluxo de trabalho especifica ubuntu-latest. Por padrão, os executores do Linux usam o shell do Bash. Portanto, você precisa usar a sintaxe $NAME. Por padrão, os executores do Windows usam o PowerShell, então, você usaria a sintaxe $env:NAME. Para saber mais sobre shells, confira "Sintaxe de fluxo de trabalho para o GitHub Actions".

Convenções de nomenclatura para variáveis de ambiente

Ao definir uma variável de ambiente, você não pode usar nenhum dos nomes das variáveis de ambiente padrão. Para obter uma lista completa das variáveis de ambiente padrão, confira "Variáveis de ambiente padrão", abaixo. Se você tentar substituir o valor de uma dessas variáveis padrão, a atribuição será ignorada.

Qualquer nova variável que você definir e apontar para uma localização no sistema de arquivos deverá ter um sufixo _PATH. As variáveis padrão GITHUB_ENV e GITHUB_WORKSPACE são exceções a essa convenção.

Como usar contextos para acessar valores de variáveis

Os contextos são uma forma de acessar informações sobre execuções de fluxo de trabalho, variáveis, ambientes dos executores, trabalhos e etapas. Para obter mais informações, confira "Contextos". Há muitos outros contextos que você pode usar para uma série de finalidades nos seus fluxos de trabalho. Para obter detalhes sobre quando usar contextos específicos em um fluxo de trabalho, confira "Contextos".

Você pode acessar valores de variáveis de ambiente usando o contexto env.

Como usar o contexto env para acessar valores de variáveis de ambiente

Além das variáveis de ambiente do executor, GitHub Actions permite que você defina e leia valores da chave env usando contextos. As variáveis e os contextos do ambiente são destinados a serem usados em diferentes pontos do fluxo de trabalho.

As etapas run em um fluxo de trabalho ou em uma ação referenciada são processadas por um executor. Como resultado, você pode usar variáveis de ambiente de executor aqui, usando a sintaxe apropriada para o shell que você está usando no executor; por exemplo, $NAME para o shell bash em um executor do Linux ou $env:NAME para o PowerShell em um executor do Windows. Na maioria dos casos, você também pode usar contextos, com a sintaxe ${{ CONTEXT.PROPERTY }}, para acessar o mesmo valor. A diferença é que o contexto será interpolado e substituído por uma cadeia de caracteres antes que o trabalho seja enviado a um executor.

No entanto, não é possível usar variáveis de ambiente do executor em partes de um fluxo de trabalho que são processadas pelo GitHub Actions e não são enviadas ao executor. Em vez disso, você deve usar contextos. Por exemplo, um condicional if, que determina se uma etapa ou um trabalho é enviado ao executor, sempre será processado pelo GitHub Actions. Portanto, você deve usar um contexto em uma instrução condicional if para acessar o valor de uma variável.

env:
  DAY_OF_WEEK: Monday

jobs:
  greeting_job:
    runs-on: ubuntu-latest
    env:
      Greeting: Hello
    steps:
      - name: "Say Hello Mona it's Monday"
        if: ${{ env.DAY_OF_WEEK == 'Monday' }}
        run: echo "$Greeting $First_Name. Today is $DAY_OF_WEEK!"
        env:
          First_Name: Mona

env:
  DAY_OF_WEEK: Monday

jobs:
  greeting_job:
    runs-on: ubuntu-latest
    env:
      Greeting: Hello
    steps:
      - name: "Say Hello Mona it's Monday"
        if: ${{ env.DAY_OF_WEEK == 'Monday' }}
        run: echo "$Greeting $First_Name. Today is $DAY_OF_WEEK!"
        env:
          First_Name: Mona

Nessa modificação do exemplo anterior, introduzimos um if condicional. A etapa de fluxo de trabalho agora só será executada se DAY_OF_WEEK estiver definido como "Segunda-feira". Acessamos esse valor por meio da instrução condicional if usando o contexto env. O contexto env não é necessário para as variáveis referenciadas no comando run. Elas são referenciadas como variáveis de ambiente do executor e são interpoladas depois que o trabalho é recebido pelo executor. No entanto, poderíamos ter optado por interpolar essas variáveis antes de enviar o trabalho ao executor, usando contextos. A saída resultante seria a mesma.

run: echo "${{ env.Greeting }} ${{ env.First_Name }}. Today is ${{ env.DAY_OF_WEEK }}!"

Normalmente, você usará o contexto env ou github para acessar valores de variáveis em partes do fluxo de trabalho processadas antes que os trabalhos sejam enviados aos executores.

Variáveis de ambiente padrão

As variáveis de ambiente padrão que os conjuntos de GitHub estão disponíveis para cada etapa de um fluxo de trabalho.

Como as variáveis de ambiente padrão são definidas por GitHub e não são definidas em um fluxo de trabalho, elas não são acessíveis por meio do contexto de env. No entanto, a maioria das variáveis padrão tem uma propriedade de contexto correspondente e nomeada de modo semelhante. Por exemplo, o valor da variável GITHUB_REF pode ser lido durante o processamento do fluxo de trabalho por meio da propriedade de contexto ${{ github.ref }}.

Não é possível substituir o valor das variáveis de ambiente padrão chamadas GITHUB_* e RUNNER_*. Atualmente, você pode substituir o valor da variável CI. No entanto, não é garantido que isso sempre será possível. Para obter mais informações sobre como definir variáveis de ambiente, consulte "Definir variáveis de ambiente para um único fluxo de trabalho" e "Comandos de fluxo de trabalho para o GitHub Actions".

É altamente recomendável que as ações usem variáveis para acessar o sistema do arquivo em vez de usar caminhos de arquivo embutidos no código. O GitHub define as variáveis para ações a serem usadas em todos os ambientes do executor.

Detectando o sistema operacional

Você pode escrever um arquivo de fluxo de trabalho individual que pode ser usado para diferentes sistemas operacionais usando a variável de ambiente RUNNER_OS padrão e a propriedade de contexto correspondente ${{ runner.os }}. Por exemplo, o fluxo de trabalho a seguir poderá ser executado com sucesso se você alterar o sistema operacional de macos-latest para windows-latest sem precisar alterar a sintaxe das variáveis de ambiente, que varia conforme o shell que está sendo usado pelo executor.

jobs:
  if-Windows-else:
    runs-on: macos-latest
    steps:
      - name: condition 1
        if: runner.os == 'Windows'
        run: echo "The operating system on the runner is $env:RUNNER_OS."
      - name: condition 2
        if: runner.os != 'Windows'
        run: echo "The operating system on the runner is not Windows, it's $RUNNER_OS."

jobs:
  if-Windows-else:
    runs-on: macos-latest
    steps:
      - name: condition 1
        if: runner.os == 'Windows'
        run: echo "The operating system on the runner is $env:RUNNER_OS."
      - name: condition 2
        if: runner.os != 'Windows'
        run: echo "The operating system on the runner is not Windows, it's $RUNNER_OS."

Neste exemplo, as duas instruções if verificam a propriedade os do contexto runner para determinar o sistema operacional do executor. Os condicionais if são processados pelo GitHub Actions, e somente as etapas em que a verificação resolve como true são enviadas ao executor. Aqui, uma das verificações sempre será true e a outra false. Portanto, apenas uma dessas etapas será enviada ao executor. Assim que o trabalho for enviado ao executor, a etapa será executada e a variável de ambiente no comando echo será interpolada com a sintaxe apropriada ($env:NAME para o PowerShell no Windows e $NAME para o Bash e o sh no Linux e no macOS). Neste exemplo, a instrução runs-on: macos-latest significa que a segunda etapa será executada.

Passando valores entre etapas e trabalhos em um fluxo de trabalho

Se você gerar um valor em uma etapa de um trabalho, poderá usar o valor em etapas posteriores do mesmo trabalho atribuindo o valor a uma variável de ambiente nova ou existente e gravando isso no arquivo de ambiente GITHUB_ENV. O arquivo de ambiente pode ser usado diretamente por uma ação ou em um comando do shell no arquivo de fluxo de trabalho usando a palavra-chave run. Para obter mais informações, confira "Comandos de fluxo de trabalho para o GitHub Actions".

Se você deseja passar um valor de uma etapa de um trabalho em um fluxo de trabalho para uma etapa de outro trabalho no fluxo de trabalho, você poderá definir o valor como uma saída de trabalho. Em seguida, você poderá fazer referência a saída desse trabalho a partir de uma etapa em outro trabalho. Para obter mais informações, confira "Sintaxe de fluxo de trabalho para o GitHub Actions".