From c09a04ec015d98f209132f95f774a1c92ac6e419 Mon Sep 17 00:00:00 2001 From: toast-gear Date: Mon, 11 Jul 2022 19:17:33 +0100 Subject: [PATCH] docs: add default label considerations --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 908fd38d..00b1068f 100644 --- a/README.md +++ b/README.md @@ -1590,7 +1590,10 @@ jobs: runs-on: custom-runner ``` -Note that if you specify `self-hosted` in your workflow, then this will run your job on _any_ self-hosted runner, regardless of the labels that they have. +When using labels there are a few things to be aware of: + +1. `self-hosted` is implict with every runner as this is an automatic label GitHub apply to any self-hosted runner. As a result ARC can treat all runners as having this label without physically having it a runner's manifest. You do not need to explicitly define this label in your runner manifests (you can if you want though). +2. In addition to the `self-hosted` label, GitHub also applies a few other [default](https://docs.github.com/en/actions/hosting-your-own-runners/using-self-hosted-runners-in-a-workflow#using-default-labels-to-route-jobs) labels to any self-hosted runner. These other default labels relate to the architecture of the runner and so can't be implicitly assumed by ARC as ARC doesn't know if your runner is `linux` or `windows`, `x64` or `ARM64`. If you wish to use these labels in your workflows you must add them to your runner manifests or ARC will ignore them. ### Runner Groups