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

A self-hosted runner can be located in either your repository, organization, or enterprise settings on your enterprise. To manage a self-hosted runner, you must have the following permissions, depending on where the self-hosted runner was added:

  • User repository: You must be the repository owner.

  • Organization: You must be an organization owner.

  • Organization repository: You must be an organization owner, or have admin access to the repository.

  • Enterprise: You must be a GitHub Enterprise site administrator.

Creating a custom label

  1. ランナーが登録されている場所に移動します。

    • Organization またはリポジトリ内: メイン ページに移動して、 [設定] をクリックします。

    • Enterprise レベルのランナーを使用している場合:

      1. GitHub AE の右上で、ご自分のプロファイル写真をクリックしてから、 [Enterprise 設定] をクリックします。 GitHub AE のプロファイル写真のドロップダウン メニューの [自分の Enterprise]
  2. GitHub Actions設定にアクセスしてください:

    • Organization またはリポジトリ内:

      1. In the left sidebar, click Actions.
      2. In the left sidebar, under "Actions", click Runners.
    • Enterprise レベルのランナーを使用している場合:

      1. Enterprise サイドバーで、 [ポリシー] をクリックします。 [Enterprise アカウント] サイドバーの [ポリシー] タブ 1. [ ポリシー] で、 [アクション] をクリックします。 1. [Runners](ランナー) タブをクリックします。
  3. [Runners](ランナー) の下にあるランナーの一覧を見つけます。

  4. ランナーがグループ内にあるなら、そのランナーグループを見つけてをクリックし、ランナーのリストを表示させてください。 ランナーグループをリスト

  5. 更新したいランナーを見つけて、をクリックしてラベル選択メニューを表示させてください。 このメニューには、セルフホステッド ランナーで使用できるすべてのカスタム ラベルが表示されます。 セルフホステッド ランナーに既に割り当て済みのラベルには、隣に が表示されます。 ランナーラベルの変更

  6. In the "Filter labels" field, type the name of your new label, and click Create new label. Add runner 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. ランナーに割り当てられていない、未使用のラベルは、24時間以内に自動的に削除されます。

Assigning a label to a self-hosted runner

  1. ランナーが登録されている場所に移動します。

    • Organization またはリポジトリ内: メイン ページに移動して、 [設定] をクリックします。

    • Enterprise レベルのランナーを使用している場合:

      1. GitHub AE の右上で、ご自分のプロファイル写真をクリックしてから、 [Enterprise 設定] をクリックします。 GitHub AE のプロファイル写真のドロップダウン メニューの [自分の Enterprise]
  2. GitHub Actions設定にアクセスしてください:

    • Organization またはリポジトリ内:

      1. In the left sidebar, click Actions.
      2. In the left sidebar, under "Actions", click Runners.
    • Enterprise レベルのランナーを使用している場合:

      1. Enterprise サイドバーで、 [ポリシー] をクリックします。 [Enterprise アカウント] サイドバーの [ポリシー] タブ 1. [ ポリシー] で、 [アクション] をクリックします。 1. [Runners](ランナー) タブをクリックします。
  3. [Runners](ランナー) の下にあるランナーの一覧を見つけます。

  4. ランナーがグループ内にあるなら、そのランナーグループを見つけてをクリックし、ランナーのリストを表示させてください。 ランナーグループをリスト

  5. 更新したいランナーを見つけて、をクリックしてラベル選択メニューを表示させてください。 このメニューには、セルフホステッド ランナーで使用できるすべてのカスタム ラベルが表示されます。 セルフホステッド ランナーに既に割り当て済みのラベルには、隣に が表示されます。 ランナーラベルの変更

  6. Click on a label to assign it to your self-hosted runner.

Removing a custom label from a self-hosted runner

  1. ランナーが登録されている場所に移動します。

    • Organization またはリポジトリ内: メイン ページに移動して、 [設定] をクリックします。

    • Enterprise レベルのランナーを使用している場合:

      1. GitHub AE の右上で、ご自分のプロファイル写真をクリックしてから、 [Enterprise 設定] をクリックします。 GitHub AE のプロファイル写真のドロップダウン メニューの [自分の Enterprise]
  2. GitHub Actions設定にアクセスしてください:

    • Organization またはリポジトリ内:

      1. In the left sidebar, click Actions.
      2. In the left sidebar, under "Actions", click Runners.
    • Enterprise レベルのランナーを使用している場合:

      1. Enterprise サイドバーで、 [ポリシー] をクリックします。 [Enterprise アカウント] サイドバーの [ポリシー] タブ 1. [ ポリシー] で、 [アクション] をクリックします。 1. [Runners](ランナー) タブをクリックします。
  3. [Runners](ランナー) の下にあるランナーの一覧を見つけます。

  4. ランナーがグループ内にあるなら、そのランナーグループを見つけてをクリックし、ランナーのリストを表示させてください。 ランナーグループをリスト

  5. 更新したいランナーを見つけて、をクリックしてラベル選択メニューを表示させてください。 このメニューには、セルフホステッド ランナーで使用できるすべてのカスタム ラベルが表示されます。 セルフホステッド ランナーに既に割り当て済みのラベルには、隣に が表示されます。 ランナーラベルの変更

  6. Click on the assigned label to remove it from your self-hosted runner. ランナーに割り当てられていない、未使用のラベルは、24時間以内に自動的に削除されます。

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.