Using labels with self-hosted runners

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

In diesem Artikel

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.

Ein selbstgehosteter Runner kann entweder in den Repository-, Organisations- oder Enterprise-Kontoeinstellungen auf GitHub gefunden werden. Um einen selbst-gehosteten Läufer zu verwalten, musst Du über die folgenden Berechtigungen verfügen, abhängig davon, wo der selbst-gehostete Läufer hinzugefügt wurde:

  • Benutzer-Repository: Du musst der Repositorybesitzer sein.

  • Organisation: Du musst ein Organisationsbesitzer sein.

  • Organisationsrepository: Du musst du ein Organisationsbesitzer sein oder über Administratorzugriff auf das Repository verfügen.

  • Unternehmenskonto: Du musst ein Unternehmensbesitzer sein.

Hinweis

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, organization, and enterprise levels.

Hinweis

Labels are case-insensitive.

Creating a custom label for a repository runner

  1. Navigiere zur Hauptseite des Repositorys, in der deine selbstgehostete Runnergruppe registriert ist.
  2. Klicke auf Settings.
  3. Klicke in der linken Seitenleiste auf Aktionen und dann auf Runner.
  4. Klicke in der Liste der Runner auf den Namen des Runners, den du konfigurieren möchtest.
  5. Klicke im Abschnitt „Bezeichnungen“ auf .
  6. Gib im Feld „Bezeichnung suchen oder erstellen“ den Namen deiner neuen Bezeichnung ein, und klicke auf Neue Bezeichnung erstellen. Das benutzerdefinierte Label wird erstellt und dem selbst-gehosteten Runner zugewiesen. Benutzerdefinierte Labels können von selbst-gehosteten Runnern entfernt werden, aber sie können derzeit nicht manuell gelöscht werden. Alle unbenutzten Kennzeichnungen, die keinem Läufer zugewiesen sind, werden innerhalb von 24 Stunden automatisch gelöscht.

Creating a custom label for an organization runner

  1. Navigiere zur Hauptseite der Organisation, in der deine selbstgehostete Runnergruppe registriert ist.
  2. Klicke auf Settings.
  3. Klicke in der linken Seitenleiste auf Aktionen und dann auf Runner.
  4. Klicke in der Liste der Runner auf den Namen des Runners, den du konfigurieren möchtest.
  5. Klicke im Abschnitt „Bezeichnungen“ auf .
  6. Gib im Feld „Bezeichnung suchen oder erstellen“ den Namen deiner neuen Bezeichnung ein, und klicke auf Neue Bezeichnung erstellen. Das benutzerdefinierte Label wird erstellt und dem selbst-gehosteten Runner zugewiesen. Benutzerdefinierte Labels können von selbst-gehosteten Runnern entfernt werden, aber sie können derzeit nicht manuell gelöscht werden. Alle unbenutzten Kennzeichnungen, die keinem Läufer zugewiesen sind, werden innerhalb von 24 Stunden automatisch gelöscht.

Creating a custom label for an enterprise runner

  1. Klicke auf GitHub in der oberen rechten Ecke auf dein Profilfoto.
  2. Klicke je nach deiner Umgebung auf Dein Unternehmenoder auf Deine Unternehmen, und klicke dann auf das Unternehmen, das du anzeigen möchtest.
  3. Klicke oben auf der Seite auf Policies.
  4. Klicke unter „ Richtlinien“ auf Actions.
  5. Klicke auf die Registerkarte Runner.
  6. Klicke in der Liste der Runner auf den Namen des Runners, den du konfigurieren möchtest.
  7. Klicke im Abschnitt „Bezeichnungen“ auf .
  8. Gib im Feld „Bezeichnung suchen oder erstellen“ den Namen deiner neuen Bezeichnung ein, und klicke auf Neue Bezeichnung erstellen. Das benutzerdefinierte Label wird erstellt und dem selbst-gehosteten Runner zugewiesen. Benutzerdefinierte Labels können von selbst-gehosteten Runnern entfernt werden, aber sie können derzeit nicht manuell gelöscht werden. Alle unbenutzten Kennzeichnungen, die keinem Läufer zugewiesen sind, werden innerhalb von 24 Stunden automatisch gelöscht.

Assigning a label to a self-hosted runner

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

Assigning a label to a repository runner

  1. Navigiere zur Hauptseite des Repositorys, in der deine selbstgehostete Runnergruppe registriert ist.
  2. Klicke auf Settings.
  3. Klicke in der linken Seitenleiste auf Aktionen und dann auf Runner.
  4. Klicke im Abschnitt „Bezeichnungen“ auf .
  5. Wenn du deinem selbstgehosteten Runner eine Bezeichnung zuweisen möchtest, klickst du im Feld „Bezeichnung suchen oder erstellen“ auf die Bezeichnung.

Assigning a label to an organization runner

  1. Navigiere zur Hauptseite der Organisation, in der deine selbstgehostete Runnergruppe registriert ist.
  2. Klicke auf Settings.
  3. Klicke in der linken Seitenleiste auf Aktionen und dann auf Runner.
  4. Klicke im Abschnitt „Bezeichnungen“ auf .
  5. Wenn du deinem selbstgehosteten Runner eine Bezeichnung zuweisen möchtest, klickst du im Feld „Bezeichnung suchen oder erstellen“ auf die Bezeichnung.

Assigning a label to an enterprise runner

  1. Klicke auf GitHub in der oberen rechten Ecke auf dein Profilfoto.
  2. Klicke je nach deiner Umgebung auf Dein Unternehmenoder auf Deine Unternehmen, und klicke dann auf das Unternehmen, das du anzeigen möchtest.
  3. Klicke oben auf der Seite auf Policies.
  4. Klicke unter „ Richtlinien“ auf Actions.
  5. Klicke auf die Registerkarte Runner.
  6. Klicke in der Liste der Runner auf den Namen des Runners, den du konfigurieren möchtest.
  7. Klicke im Abschnitt „Bezeichnungen“ auf .
  8. Wenn du deinem selbstgehosteten Runner eine Bezeichnung zuweisen möchtest, klickst du im Feld „Bezeichnung suchen oder erstellen“ auf die Bezeichnung.

Removing a custom label from a self-hosted runner

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

Removing a custom label from a repository runner

  1. Navigiere zur Hauptseite des Repositorys, in der deine selbstgehostete Runnergruppe registriert ist.
  2. Klicke auf Settings.
  3. Klicke in der linken Seitenleiste auf Aktionen und dann auf Runner.
  4. Klicke im Abschnitt „Bezeichnungen“ auf .
  5. Im Feld „Bezeichnung suchen oder erstellen“ werden zugewiesene Bezeichnungen mit dem Symbol markiert. Klicke auf eine markierte Bezeichnung, um die Zuweisung zu deinem selbstgehosteten Runner aufzuheben.

Removing a custom label from an organization runner

  1. Navigiere zur Hauptseite der Organisation, in der deine selbstgehostete Runnergruppe registriert ist.
  2. Klicke auf Settings.
  3. Klicke in der linken Seitenleiste auf Aktionen und dann auf Runner.
  4. Klicke im Abschnitt „Bezeichnungen“ auf .
  5. Im Feld „Bezeichnung suchen oder erstellen“ werden zugewiesene Bezeichnungen mit dem Symbol markiert. Klicke auf eine markierte Bezeichnung, um die Zuweisung zu deinem selbstgehosteten Runner aufzuheben.

Removing a custom label from an enterprise runner

  1. Klicke auf GitHub in der oberen rechten Ecke auf dein Profilfoto.
  2. Klicke je nach deiner Umgebung auf Dein Unternehmenoder auf Deine Unternehmen, und klicke dann auf das Unternehmen, das du anzeigen möchtest.
  3. Klicke oben auf der Seite auf Policies.
  4. Klicke unter „ Richtlinien“ auf Actions.
  5. Klicke auf die Registerkarte Runner.
  6. Klicke in der Liste der Runner auf den Namen des Runners, den du konfigurieren möchtest.
  7. Klicke im Abschnitt „Bezeichnungen“ auf .
  8. Im Feld „Bezeichnung suchen oder erstellen“ werden zugewiesene Bezeichnungen mit dem Symbol markiert. Klicke auf eine markierte Bezeichnung, um die Zuweisung zu deinem selbstgehosteten Runner aufzuheben.

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 REST-API-Endpunkte für selbst gehostete Runner.

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

    Hinweis

    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

    Hinweis

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