Skip to main content

Using labels with self-hosted runners

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

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."

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.

  • Cuenta empresarial: debe ser propietario de la empresa.

Creating a custom label

  1. Navega a donde está registrado tu ejecutor:

    • En un repositorio u organización: vaya a la página principal y haga clic en Settings (Configuración).

    • Si usa un ejecutor de nivel empresarial:

      1. En la esquina superior derecha de GitHub.com, haga clic en la imagen de perfil y después en Your enterprises. "Your enterprises" en el menú desplegable de la imagen de perfil en GitHub Enterprise Cloud

      2. En la lista de empresas, da clic en aquella que quieras ver. Nombre de una empresa en la lista de sus empresas

  2. Navega a los ajustes de GitHub Actions:

    • En una organización o repositorio:

      1. In the left sidebar, click Actions, then click Runners.
    • Si usa un ejecutor de nivel empresarial:

      1. En la barra lateral de la empresa, haz clic en Directivas. Pestaña Directivas en la barra lateral de la cuenta de empresa 1. En " Directivas", haz clic en Acciones. 1. Haz clic en la pestaña Ejecutores.
  3. En la lista de ejecutores, haz clic en el que te gustaría configurar.

  4. In the "Labels" section, click .

  5. In the "Find or create a label" field, type the name of your new label and click Create new label. The custom label is created and assigned to the self-hosted runner. Custom labels can be removed from self-hosted runners, but they currently can't be manually deleted. 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

  1. Navega a donde está registrado tu ejecutor:

    • En un repositorio u organización: vaya a la página principal y haga clic en Settings (Configuración).

    • Si usa un ejecutor de nivel empresarial:

      1. En la esquina superior derecha de GitHub.com, haga clic en la imagen de perfil y después en Your enterprises. "Your enterprises" en el menú desplegable de la imagen de perfil en GitHub Enterprise Cloud

      2. En la lista de empresas, da clic en aquella que quieras ver. Nombre de una empresa en la lista de sus empresas

  2. Navega a los ajustes de GitHub Actions:

    • En una organización o repositorio:

      1. In the left sidebar, click Actions, then click Runners.
    • Si usa un ejecutor de nivel empresarial:

      1. En la barra lateral de la empresa, haz clic en Directivas. Pestaña Directivas en la barra lateral de la cuenta de empresa 1. En " Directivas", haz clic en Acciones. 1. Haz clic en la pestaña Ejecutores.
  3. En la lista de ejecutores, haz clic en el que te gustaría configurar.

  4. En la sección de "Etiquetas", haz clic en .

  5. To assign a label to your self-hosted runner, in the "Find or create a label" field, click the label.

Removing a custom label from a self-hosted runner

  1. Navega a donde está registrado tu ejecutor:

    • En un repositorio u organización: vaya a la página principal y haga clic en Settings (Configuración).

    • Si usa un ejecutor de nivel empresarial:

      1. En la esquina superior derecha de GitHub.com, haga clic en la imagen de perfil y después en Your enterprises. "Your enterprises" en el menú desplegable de la imagen de perfil en GitHub Enterprise Cloud

      2. En la lista de empresas, da clic en aquella que quieras ver. Nombre de una empresa en la lista de sus empresas

  2. Navega a los ajustes de GitHub Actions:

    • En una organización o repositorio:

      1. In the left sidebar, click Actions, then click Runners.
    • Si usa un ejecutor de nivel empresarial:

      1. En la barra lateral de la empresa, haz clic en Directivas. Pestaña Directivas en la barra lateral de la cuenta de empresa 1. En " Directivas", haz clic en Acciones. 1. Haz clic en la pestaña Ejecutores.
  3. En la lista de ejecutores, haz clic en el que te gustaría configurar.

  4. En la sección de "Etiquetas", haz clic en .

  5. In the "Find or create a label" field, assigned labels are marked with the icon. Click on a marked label to unassign it from your self-hosted runner.

Using the configuration script to create and assign labels

You can use the configuration script on the self-hosted runner to create and assign custom labels. For example, this command assigns a label named gpu to the self-hosted runner.

./config.sh --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 --labels gpu,x64,linux

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