Contextos

Sobre os contextos

Os contextos são uma forma de acessar informações sobre execuções de fluxo de trabalho, ambientes dos executores, trabalhos e etapas. Contextos usam a sintaxe de expressão. Para obter mais informações, consulte "Expressões".

${{ <context> }}

Nome do contexto	Tipo	Descrição
github	objeto	Informações sobre a execução do fluxo de trabalho. Para obter mais informações, consulte contexto github.
env	objeto	Contém variáveis de ambiente definidas em um fluxo de trabalho, trabalho ou etapa. Para obter mais informações, consulte o contexto env.
trabalho	objeto	Tem informações sobre o trabalho em execução no momento. Para obter mais informações, consulte contexto trabalho.
steps	objeto	Informações sobre as etapas que foram executadas neste trabalho. Para obter mais informações, consulte contexto etapas.
runner	objeto	Informações sobre o executor do trabalho atual. Para obter mais informações, consulte runner context.
secrets	objeto	Habilita o acesso a segredos. Para obter mais informações sobre segredos, consulte "Criar e usar segredos encriptados".
strategy	objeto	Habilita acesso aos parâmetros de estratégia configurados e informações sobre o trabalho atual. Parâmetros de estratégia incluem fail-fast, job-index, job-total e max-parallel.
matrix	objeto	Habilita acesso aos parâmetros de matriz configurados para o trabalho atual. Por exemplo, se você configurar uma criação de matriz com as versões os e node, o objeto de contexto matrix inclui as versões os e node do trabalho atual.
needs	objeto	Permite o acesso às saídas de todos os trabalhos definidos como uma dependência do trabalho atual. Para obter mais informações, consulte o contexto needs.

Como parte de uma expressão, você pode acessar as informações de contexto usando uma das duas sintaxes:

• Sintaxe de índice: github['sha'];
• Sintaxe de propriedade de desreferência: github.sha

Para usar a sintaxe de propriedade de desreferência, o nome da propriedade deve:

• começar com a-Z ou _;
• ser seguido por a-Z 0-9 - ou _.

Determinar quando usar contextos

GitHub Actions inclui uma coleção de variáveis denominadas contextos e uma coleção similar de variáveis denominadas variáveis de ambiente padrão. Estas variáveis são destinadas a serem usadas em diferentes pontos do fluxo de trabalho:

• Variáveis de ambiente padrão: Essas variáveis existem apenas no executor que está executando seu trabalho. Para obter mais informações, consulte "Variáveis de ambiente padrão".
• Contextos: Você pode usar a maioria dos contextos em qualquer ponto do seu fluxo de trabalho, incluindo quando as variáveis de ambiente padrão estariam indisponíveis. Por exemplo, você pode usar contextos com expressões para realizar o processamento inicial antes que o trabalho seja encaminhado para um executor para execução. Isso permite que você use um contexto com a palavra-chave condicional if para determinar se uma etapa deve ser executada. Assim que o trabalho estiver em execução, você também poderá recuperar as variáveis de contexto do executor que está executando o trabalho, como runner.os. Para obter informações sobre onde você pode usar vários contextos dentro de um fluxo de trabalho, consulte "Disponibilidade de contexto".

O exemplo a seguir demonstra como esses diferentes tipos de variáveis de ambiente podem ser usados juntos em um trabalho:

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"

Neste exemplo, o comando if verifica o github.ref para determinar o nome do branch atual. Se o nome for refs/heads/main, as etapas subsequentes serão executadas. A verificação if é processada por GitHub Actions, e o trabalho é enviado apenas para o executor se o resultado for verdadeiro. Assim que o trabalho é enviado para o executor, a etapa é executada e refere-se à variável de ambiente $GITHUB_REF do executor.

Contexto github

O contexto github context contém informações sobre a execução do fluxo de trabalho e sobre o evento que a acionou. Você pode ler a maioria dos dados de contexto github em variáveis de ambiente. Para obter mais informações sobre as variáveis de ambiente, consulte "Usando variáveis de ambiente".

Nome da propriedade	Tipo	Descrição
github	objeto	Contexto de nível mais alto disponível em qualquer trabalho ou etapa de um fluxo de trabalho.
github.action	string	O nome da ação atualmente em execução. GitHub remove caracteres especiais ou usa o nome __run quando a etapa atual executa um script. Se você usar a mesma ação mais de uma vez no mesmo trabalho, o nome incluirá um sufixo com o número da sequência com o sublinhado antes dele. Por exemplo, o primeiro script que você executar terá o nome __run e o segundo script será denominado __run_2. Da mesma forma, a segunda invocação de actions/checkout será actionscheckout2.
github.action_path	string	O caminho onde está localizada a sua ação. Você pode usar esse caminho para acessar facilmente os arquivos localizados no mesmo repositório que sua ação. Este atributo é compatível apenas em ações compostas.
github.actor	string	Login do usuário que iniciou a execução do fluxo de trabalho.
github.base_ref	string	base_ref ou branch alvo da pull request em uma execução de fluxo de trabalho. Esta propriedade só está disponível quando o evento que aciona a execução de um fluxo de trabalho for pull_request ou pull_request_target.
github.event	objeto	Carga de evento de webhook completa. Para obter mais informações, consulte "Eventos que acionam fluxos de trabalho". Você pode acessar as propriedades individuais do evento usando este contexto.
github.event_name	string	Nome do evento que acionou a execução do fluxo de trabalho.
github.event_path	string	O caminho para a carga completa do evento do webhook no executor.
github.head_ref	string	head_ref ou branch de origem da pull request em uma execução de fluxo de trabalho. Esta propriedade só está disponível quando o evento que aciona a execução de um fluxo de trabalho for pull_request ou pull_request_target.
github.job	string	O job_id do trabalho atual.
github.ref	string	Branch ou ref tag que acionou a execução do fluxo de trabalho. Para branches, este é o formato refs/heads/<branch_name> e, para tags, é refs/tags/<tag_name>.
github.repository	string	Nome do repositório e o proprietário. Por exemplo, Codertocat/Hello-World.
github.repository_owner	string	O nome do proprietário do repositório. Por exemplo, Codertocat.
github.run_id	string	Um número exclusivo para cada execução em um repositório. Este número não muda se você executar novamente o fluxo de trabalho.
github.run_number	string	Um número exclusivo para cada execução de um fluxo de trabalho específico em um repositório. Este número começa em 1 para a primeira execução do fluxo de trabalho, e incrementa a cada nova execução. Este número não muda se você executar novamente o fluxo de trabalho.
github.run_attempt	string	Um número exclusivo para cada tentativa de execução de um fluxo de trabalho específico em um repositório. Este número começa em 1 para a primeira tentativa de execução do fluxo de trabalho e aumenta a cada nova execução.
github.server_url	string	Retorna a URL do servidor GitHub. Por exemplo: https://github.com.
github.sha	string	Commit SHA que acionou a execução do fluxo de trabalho.
github.token	string	Um token para fazer a autenticação em nome do aplicativo GitHub instalado no seu repositório. Isso é funcionalmente equivalente ao segredo GITHUB_TOKEN. Para obter mais informações, consulte "Permissões para o GITHUB_TOKEN".
github.workflow	string	Nome do fluxo de trabalho. Se o fluxo de trabalho não determina um name (nome), o valor desta propriedade é o caminho completo do arquivo do fluxo de trabalho no repositório.
github.workspace	string	O diretório-padrão de trabalho para etapas e a localização-padrão do repositório ao usar a ação checkout-.

Contexto env

O contexto env contém variáveis de ambiente que foram definidas em um fluxo de trabalho, trabalho ou etapa. Para obter mais informações sobre como configurar variáveis de ambiente em seu fluxo de trabalho, consulte "Sintaxe do fluxo de trabalho para GitHub Actions".

A sintaxe de contexto env permite que você use o valor de uma variável de ambiente no seu arquivo de fluxo de trabalho. Você pode usar o contexto env no valor de qualquer chave em uma etapa, exceto para as chaves id e uses. Para obter mais informações sobre a sintaxe da etapa, consulte "Sintaxe do fluxo de trabalho para o GitHub Actions".

Se você desejar usar o valor de uma variável de ambiente dentro de um executor, use o método normal do sistema operacional do executor para ler as variáveis de ambiente.

Nome da propriedade	Tipo	Descrição
env	objeto	Esse contexto altera cada etapa em um trabalho. Você pode acessar esse contexto em qualquer etapa de um trabalho.
env.<env_name>	string	O valor de uma variável de ambiente específica.

Contexto trabalho

O contexto job (trabalho) contém informações sobre o trabalho atualmente em execução.

Nome da propriedade	Tipo	Descrição
trabalho	objeto	Esse contexto altera cada trabalho em uma execução de fluxo de trabalho. Você pode acessar esse contexto em qualquer etapa de um trabalho.
job.container	objeto	Informações sobre o contêiner do trabalho. Para obter mais informações sobre contêineres, consulte "Sintaxe de fluxo de trabalho para o GitHub Actions".
job.container.id	string	Identificação do contêiner.
job.container.network	string	Identificação da rede do contêiner. O executor cria a rede usada por todos os contêineres em um trabalho.
job.services	objeto	Contêineres de serviços criados para um trabalho. Para obter mais informações sobre contêineres de serviço, consulte "Sintaxe de fluxo de trabalho para o GitHub Actions".
job.services.<service id>.id	string	Identificação do contêiner de serviço.
job.services.<service id>.network	string	Identificação da rede do contêiner de serviço. O executor cria a rede usada por todos os contêineres em um trabalho.
job.services.<service id>.ports	objeto	As portas expostas do contêiner de serviço.
job.status	string	Status atual do trabalho. Possíveis valores são success, failure ou cancelled.

Contexto etapas

O contexto steps (etapas) contém informações sobre as etapas já executadas do trabalho atual.

Nome da propriedade	Tipo	Descrição
steps	objeto	Esse contexto altera cada etapa em um trabalho. Você pode acessar esse contexto em qualquer etapa de um trabalho.
steps.<step id>.outputs	objeto	Conjunto de saídas definidas para a etapa. Para obter mais informações, consulte "Sintaxe de metadados para o GitHub Actions".
steps.<step id>.conclusion	string	O resultado de uma etapa concluída após continue-on-error ser aplicado. Os valores possíveis são: sucesso, falha, canceladoou ignorado. Quando ocorre uma falha na etapa de continue-on-error, o resultado será falha, mas a conclusão final será sucesso.
steps.<step id>.outcome	string	O resultado de uma etapa concluída antes de continue-on-error ser aplicado. Os valores possíveis são: sucesso, falha, canceladoou ignorado. Quando ocorre uma falha na etapa de continue-on-error, o resultado será falha, mas a conclusão final será sucesso.
steps.<step id>.outputs.<output name>	string	Valor de uma saída específica.

Contexto do executor

O contexto do executor contém informações sobre o executor que está executando o trabalho atual.

Nome da propriedade	Tipo	Descrição
runner.name	string	The name of the runner executing the job.
runner.os	string	O sistema operacional do executor que está executando o trabalho. Os valores possíveis são: Linux, Windows ou macOS.
runner.temp	string	O caminho para um diretório temporário no executor. Este diretório é esvaziado no início e no final de cada trabalho. Observe que os arquivos não serão removidos se a conta de usuário do executor não tiver permissão para excluí-los.
runner.tool_cache	string	O caminho para o diretório que contém ferramentas pré-instaladas para executores hospedados em GitHub. Para obter mais informações, consulte "Especificações para executores hospedados no GitHub".

Contexto needs

O contexto needs contém saídas de todos os trabalhos definidos como uma dependência do trabalho atual. Para obter mais informações sobre a definição de dependências de tarefas, consulte "Sintaxe de fluxo de trabalho para o GitHub Actions".

Nome da propriedade	Tipo	Descrição
needs.<job id>	objeto	Um único trabalho do qual o trabalho atual depende.
needs.<job id>.outputs	objeto	O conjunto de saídas de um trabalho do qual o trabalho atual depende.
needs.<job id>.outputs.<output name>	string	O valor de uma saída específica para um trabalho do qual o trabalho atual depende.
needs.<job id>.result	string	O resultado de um trabalho do qual depende o trabalho atual. Os valores possíveis são: sucesso, falha, canceladoou ignorado.

Exemplo de impressão de informações de contexto no arquivo de log

Para inspecionar as informações acessíveis em cada contexto, você pode usar este exemplo de arquivo de fluxo de trabalho.

.github/workflows/main.yml

on: push

jobs:
  one:
    runs-on: ubuntu-latest
    steps:
      - name: Dump GitHub context
        env:
          GITHUB_CONTEXT: ${{ toJSON(github) }}
        run: echo "$GITHUB_CONTEXT"
      - name: Dump job context
        env:
          JOB_CONTEXT: ${{ toJSON(job) }}
        run: echo "$JOB_CONTEXT"
      - name: Dump steps context
        env:
          STEPS_CONTEXT: ${{ toJSON(steps) }}
        run: echo "$STEPS_CONTEXT"
      - name: Dump runner context
        env:
          RUNNER_CONTEXT: ${{ toJSON(runner) }}
        run: echo "$RUNNER_CONTEXT"
      - name: Dump strategy context
        env:
          STRATEGY_CONTEXT: ${{ toJSON(strategy) }}
        run: echo "$STRATEGY_CONTEXT"
      - name: Dump matrix context
        env:
          MATRIX_CONTEXT: ${{ toJSON(matrix) }}
        run: echo "$MATRIX_CONTEXT"

Disponibilidade do contexto

Contextos diferentes estão disponíveis durante a execução de um fluxo de trabalho. Por exemplo, o contexto de segredos só pode ser usado em certos lugares dentro de um trabalho.

Além disso, algumas funções só podem ser utilizadas em determinados lugares. Por exemplo, a função hashFiles não está disponível em qualquer lugar.

A tabela a seguir indica onde cada contexto e função especial pode ser utilizado dentro de um fluxo de trabalho. A menos que esteja listado abaixo, uma função pode ser usada em qualquer lugar.

Caminho	Contexto	Funções especiais
concorrência	github
env	github, secrets
jobs.<job_id>.concurrency	github, needs, strategy, matrix
jobs.<job_id>.container	github, needs, strategy, matrix
jobs.<job_id>.container.credentials	github, needs, strategy, matrix, env, secrets
jobs.<job_id>.container.env.<env_id>	github, needs, strategy, matrix, job, runner, env, secrets
jobs.<job_id>.continue-on-error	github, needs, strategy, matrix
jobs.<job_id>.defaults.run	github, needs, strategy, matrix, env
jobs.<job_id>.env	github, needs, strategy, matrix, secrets
jobs.<job_id>.environment	github, needs, strategy, matrix
jobs.<job_id>.environment.url	github, needs, strategy, matrix, job, runner, env, steps
jobs.<job_id>.if	github, needs	always, cancelled, success, failure
jobs.<job_id>.name	github, needs, strategy, matrix
jobs.<job_id>.outputs.<output_id>	github, needs, strategy, matrix, job, runner, env, secrets, steps
jobs.<job_id>.runs-on	github, needs, strategy, matrix
jobs.<job_id>.services	github, needs, strategy, matrix
jobs.<job_id>.services.<service_id>.credentials	github, needs, strategy, matrix, env, secrets
jobs.<job_id>.services.<service_id>.env.<env_id>	github, needs, strategy, matrix, job, runner, env, secrets
jobs.<job_id>.steps.continue-on-error	github, needs, strategy, matrix, job, runner, env, secrets, steps	hashFiles
jobs.<job_id>.steps.env	github, needs, strategy, matrix, job, runner, env, secrets, steps	hashFiles
jobs.<job_id>.steps.if	github, needs, strategy, matrix, job, runner, env, steps	always, cancelled, success, failure, hashFiles
jobs.<job_id>.steps.name	github, needs, strategy, matrix, job, runner, env, secrets, steps	hashFiles
jobs.<job_id>.steps.run	github, needs, strategy, matrix, job, runner, env, secrets, steps	hashFiles
jobs.<job_id>.steps.timeout-minutes	github, needs, strategy, matrix, job, runner, env, secrets, steps	hashFiles
jobs.<job_id>.steps.with	github, needs, strategy, matrix, job, runner, env, secrets, steps	hashFiles
jobs.<job_id>.steps.working-directory	github, needs, strategy, matrix, job, runner, env, secrets, steps	hashFiles
jobs.<job_id>.strategy	github, needs
jobs.<job_id>.timeout-minutes	github, needs, strategy, matrix