Using labels with self-hosted runners

You can use labels to organize your self-hosted runners based on their characteristics.

En este artículo

For information on how to use labels to route jobs to specific types of self-hosted runners, see Using self-hosted runners in a workflow. You can also route jobs to runners in a specific group. For more information, see Choosing the runner for a job.

Un ejecutor autohospedado se puede ubicar en al repositorio, en la organización o en la configuración de cuenta empresarial en GitHub. Para administrar un ejecutor auto-hospedado, debes tener los siguientes permisos, dependiendo de donde se agregó éste:

  • Repositorio de usuario: debe ser el propietario del repositorio.
  • Organización: debe ser el propietario de una organización.
  • Repositorio de la organización: debe ser el propietario de una organización o tener acceso de administrador al repositorio.

Nota:

Actions Runner Controller does not support multiple labels, to find out more please read our Actions Runner Controller documentation

Creating a custom label

You can create custom labels for runners at the repository and organization levels.

Nota:

Labels are case-insensitive.

Creating a custom label for a repository runner

  1. Navega a la página principal del repositorio en el que está registrado tu grupo de ejecutores auto-hospedados.
  2. Haz clic en Settings.
  3. En la barra lateral izquierda, haz clic en Acciones y, después, en Ejecutores.
  4. En la lista de ejecutores, haz clic en el nombre del ejecutor que te gustaría configurar.
  5. En la sección de "Etiquetas", haz clic en .
  6. En el campo "Buscar o crear una etiqueta", escriba el nombre de la etiqueta nueva y haga clic en Crear etiqueta. La etiqueta personalizada se creará y asignará al ejecutor auto-hospedado. Las etiquetas personalizadas pueden eliminarse de los ejecutores auto-hospedados, pero actualmente no pueden eliminarse manualmente. Cualquier etiqueta sin utilizar que no se asigne a un ejecutor se borrará automáticamente dentro de 24 horas.

Creating a custom label for an organization runner

  1. Navega a la página principal de la organización en la que está registrado tu grupo de ejecutores auto-hospedados.
  2. Haz clic en Settings.
  3. En la barra lateral izquierda, haz clic en Acciones y, después, en Ejecutores.
  4. En la lista de ejecutores, haz clic en el nombre del ejecutor que te gustaría configurar.
  5. En la sección de "Etiquetas", haz clic en .
  6. En el campo "Buscar o crear una etiqueta", escriba el nombre de la etiqueta nueva y haga clic en Crear etiqueta. La etiqueta personalizada se creará y asignará al ejecutor auto-hospedado. Las etiquetas personalizadas pueden eliminarse de los ejecutores auto-hospedados, pero actualmente no pueden eliminarse manualmente. Cualquier etiqueta sin utilizar que no se asigne a un ejecutor se borrará automáticamente dentro de 24 horas.

Assigning a label to a self-hosted runner

You can assign labels to self-hosted runners at the repository and organization levels.

Assigning a label to a repository runner

  1. Navega a la página principal del repositorio en el que está registrado tu grupo de ejecutores auto-hospedados.
  2. Haz clic en Settings.
  3. En la barra lateral izquierda, haz clic en Acciones y, después, en Ejecutores.
  4. En la sección de "Etiquetas", haz clic en .
  5. Para asignar una etiqueta a tu ejecutor auto-hospedado, en el campo de "Encuentra o crea una etiqueta", haz clic en ella.

Assigning a label to an organization runner

  1. Navega a la página principal de la organización en la que está registrado tu grupo de ejecutores auto-hospedados.
  2. Haz clic en Settings.
  3. En la barra lateral izquierda, haz clic en Acciones y, después, en Ejecutores.
  4. En la sección de "Etiquetas", haz clic en .
  5. Para asignar una etiqueta a tu ejecutor auto-hospedado, en el campo de "Encuentra o crea una etiqueta", haz clic en ella.

Removing a custom label from a self-hosted runner

You can remove custom labels from self-hosted runners at the repository and organization levels.

Removing a custom label from a repository runner

  1. Navega a la página principal del repositorio en el que está registrado tu grupo de ejecutores auto-hospedados.
  2. Haz clic en Settings.
  3. En la barra lateral izquierda, haz clic en Acciones y, después, en Ejecutores.
  4. En la sección de "Etiquetas", haz clic en .
  5. En el campo "Buscar o crear una etiqueta", las etiquetas asignadas se marcan con el icono . Haz clic en una etiqueta marcada para desasignarla de tu ejecutor auto-hospedado.

Removing a custom label from an organization runner

  1. Navega a la página principal de la organización en la que está registrado tu grupo de ejecutores auto-hospedados.
  2. Haz clic en Settings.
  3. En la barra lateral izquierda, haz clic en Acciones y, después, en Ejecutores.
  4. En la sección de "Etiquetas", haz clic en .
  5. En el campo "Buscar o crear una etiqueta", las etiquetas asignadas se marcan con el icono . Haz clic en una etiqueta marcada para desasignarla de tu ejecutor auto-hospedado.

Programmatically assign labels

You can programmatically assign labels to a self-hosted runner after the runner is created, or during its initial configuration.

  • To programmatically assign labels to an existing self-hosted runner, you must use the REST API. For more information, see Puntos de conexión de API de REST para ejecutores autohospedados.

  • To programmatically assign labels to a self-hosted runner during the initial runner configuration, you can pass label names to the config script using the labels parameter.

    Nota:

    You cannot use the config script to assign labels to an existing self-hosted runner.

    For example, this command assigns a label named gpu when configuring a new self-hosted runner:

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

    The label is created if it does not already exist. You can also use this approach to assign the default labels to runners, such as x64 or linux. When default labels are assigned using the configuration script, GitHub Actions accepts them as given and does not validate that the runner is actually using that operating system or architecture.

    You can use comma separation to assign multiple labels. For example:

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

    Nota:

    If you replace an existing runner, then you must reassign any custom labels.