Usar rótulos com os executores auto-hospedados

Você pode usar etiquetas para organizar os seus executores auto-hospedados com base em suas características.

Neste artigo

Para obter informações sobre como usar rótulos para encaminhar trabalhos para tipos específicos de executores auto-hospedados, confira "Usar os executores auto-hospedados em um fluxo de trabalho". Você também pode rotear trabalhos para executores em um grupo específico. Para obter mais informações, confira "Escolhendo o executor para um trabalho".

Um executor auto-hospedado pode estar localizado no repositório, na organização ou nas configurações de conta corporativa do GitHub. Para gerenciar um executor auto-hospedado, você deve ter as seguintes permissões, dependendo de onde o executor auto-hospedado foi adicionado:

  • Repositório do usuário: você precisa ser o proprietário do repositório.
  • Organização: você precisa ser um proprietário da organização.
  • Repositório da organização: você precisa ser um proprietário da organização ou ter acesso de administrador no repositório.

Note

O Action Runner Controller não oferece suporte para vários rótulos, para saber mais, leia a documentação do Action Runner Controller

Criar etiquetas personalizadas

Você pode criar rótulos personalizados para executores nos níveis de repositório e organização.

Note

Os rótulos não diferenciam maiúsculas de minúsculas.

Criar um rótulo personalizado para um executor de repositório

  1. Acesse a página principal do repositório onde o grupo de executor auto-hospedado está registrado.
  2. Clique em Configurações.
  3. Na barra lateral esquerda, clique em Ações e clique em Executores.
  4. Na lista de executores, clique no nome do executor que você deseja configurar.
  5. Na seção "Etiquetas", clique em .
  6. No campo "Localizar ou criar um rótulo", digite o nome do novo rótulo e clique em Criar rótulo. O rótulo personalizado é criado e atribuído ao executor auto-hospedado. É possível remover as etiquetas personalizadas dos executores auto-hospedados, mas não é possível excluí-las manualmente. Quaisquer etiquetas não utilizadas que não forem atribuídas a um executor serão automaticamente excluídas dentro de 24 horas.

Criar um rótulo personalizado para um executor de organização

  1. Navegue até a página principal da organização onde seu grupo de executores auto-hospedados está registrado.
  2. Clique em Configurações.
  3. Na barra lateral esquerda, clique em Ações e clique em Executores.
  4. Na lista de executores, clique no nome do executor que você deseja configurar.
  5. Na seção "Etiquetas", clique em .
  6. No campo "Localizar ou criar um rótulo", digite o nome do novo rótulo e clique em Criar rótulo. O rótulo personalizado é criado e atribuído ao executor auto-hospedado. É possível remover as etiquetas personalizadas dos executores auto-hospedados, mas não é possível excluí-las manualmente. Quaisquer etiquetas não utilizadas que não forem atribuídas a um executor serão automaticamente excluídas dentro de 24 horas.

Atribuir uma etiqueta a um executor auto-hospedado

Você pode atribuir executores auto-hospedados nos níveis de repositório e organização.

Atribuir um rótulo a um executor de repositório

  1. Acesse a página principal do repositório onde o grupo de executor auto-hospedado está registrado.
  2. Clique em Configurações.
  3. Na barra lateral esquerda, clique em Ações e clique em Executores.
  4. Na seção "Etiquetas", clique em .
  5. Para atribuir uma etiqueta ao executor auto-hospedado, no campo "Localizar ou criar uma etiqueta", clique na etiqueta.

Atribuir um rótulo a um executor de organização

  1. Navegue até a página principal da organização onde seu grupo de executores auto-hospedados está registrado.
  2. Clique em Configurações.
  3. Na barra lateral esquerda, clique em Ações e clique em Executores.
  4. Na seção "Etiquetas", clique em .
  5. Para atribuir uma etiqueta ao executor auto-hospedado, no campo "Localizar ou criar uma etiqueta", clique na etiqueta.

Remover uma etiqueta personalizada de um executor auto-hospedado

Você pode remover rótulos personalizados de executores auto-hospedados nos níveis de repositório e organização.

Remover um rótulo personalizado de um executor de repositório

  1. Acesse a página principal do repositório onde o grupo de executor auto-hospedado está registrado.
  2. Clique em Configurações.
  3. Na barra lateral esquerda, clique em Ações e clique em Executores.
  4. Na seção "Etiquetas", clique em .
  5. No campo "Localizar ou criar um rótulo", os rótulos atribuídos são marcados com o ícone . Clique em uma etiqueta marcada para cancelar a atribuição do seu executor auto-hospedado.

Remover um rótulo personalizado de um executor de organização

  1. Navegue até a página principal da organização onde seu grupo de executores auto-hospedados está registrado.
  2. Clique em Configurações.
  3. Na barra lateral esquerda, clique em Ações e clique em Executores.
  4. Na seção "Etiquetas", clique em .
  5. No campo "Localizar ou criar um rótulo", os rótulos atribuídos são marcados com o ícone . Clique em uma etiqueta marcada para cancelar a atribuição do seu executor auto-hospedado.

Atribuir rótulos programaticamente

É possível atribuir rótulos programaticamente a um executor auto-hospedado após a criação dele ou durante sua configuração inicial.

  • Para atribuir rótulos programaticamente a um executor auto-hospedado existente, você deve usar a API REST. Para obter mais informações, confira "Pontos de extremidade da API REST para executores auto-hospedados".

  • Para atribuir rótulos programaticamente a um executor auto-hospedado durante a configuração inicial dele, transmita nomes de rótulo ao script config usando o parâmetro labels.

    Note

    Não é possível usar o script config para atribuir rótulos a um executor auto-hospedado existente.

    Por exemplo, o seguinte comando atribui um rótulo gpu durante a configuração de um novo executor auto-hospedado:

    ./config.sh --url <REPOSITORY_URL> --token <REGISTRATION_TOKEN> --labels gpu

    Caso não exista, a etiqueta será criada. Use também essa abordagem para atribuir os rótulos padrão aos executores, como x64 ou linux. Quando as etiquetas-padrão são atribuídas usando o script de configuração, GitHub Actions aceita-as como dadas e não valida que o executor está realmente usando esse sistema operacional ou arquitetura.

    Você pode usar a separação por vírgula para atribuir múltiplas etiquetas. Por exemplo:

    ./config.sh --url <REPOSITORY_URL> --token <REGISTRATION_TOKEN> --labels gpu,x64,linux

    Note

    Se você substituir um executor existente, precisará reatribuir os rótulos personalizados.