Meta Labels

Using Meta Labels

Meta labels can be used to define custom runner labels that will be replaced by other supported labels, such as:

• type-{name}. See Specifying The Runner Image.
• in-{name}. See Specifying The Runner Location.
• image-{architecture}-{type}-{name}. See Specifying The Runner Image.
• setup-{name}. See Specifying The Custom Runner Server Setup Script.
• startup-{name}. See Specifying The Custom Runner Server Startup Script.

The meta labels can be defined using the --meta-label option. More than one meta label can be defined.

For example,

github-hetzner-runners --meta-label test-arm "self-hosted,type-cax21,image-arm-system-ubuntu-22.04" --meta-label test-x86 "self-hosted,type-cpx21,image-x86-system-ubuntu-22.04"

will define the following two meta labels:

• test-arm that will map to [self-hosted, type-cax21, image-arm-system-ubuntu-22.04]
• test-x86 that will map to [self-hosted, type-cpx21, image-x86-system-ubuntu-22.04]

Once meta labels are defined, you can use them to request a runner with the corresponding labels.

job-name:
   runs-on: [test-arm]

that will be equivalent to

job-name:
   runs-on: [self-hosted, type-cax21, image-arm-system-ubuntu-22.04]

and

job-name:
   runs-on: [test-x86]

that will be equivalent to

job-name:
   runs-on: [self-hosted, type-cpx21, image-x86-system-ubuntu-22.04]