GitHub AE is currently under limited release. Please contact our Sales Team to find out more.

Using AE hosted runners in a workflow

You can use labels to send jobs to a pool of AE hosted runners.

In this article

Note: GitHub Actions is currently in beta for GitHub AE.

Using AE hosted runners in a workflow

Labels allow you to send workflow jobs to any AE hosted runner that includes that label. You can use the default labels, and you can create your own custom labels.

Using default labels to route jobs

An AE hosted runner receives a label when it is added to GitHub Actions. The label is used to indicate where it was assigned.

You can use your workflow's YAML to send jobs to a specific AE hosted runner pool. This example demonstrates how to configure a workflow to run on a label called AE-runner-for-CI:

runs-on: [AE-runner-for-CI]

For more information, see "Workflow syntax for GitHub Actions."

Using custom labels to route jobs

You can create custom labels and assign them to your AE hosted runners at any time. Custom labels let you send jobs to particular types of runners, based on how they're labeled.

For example, if you have a job that requires a specific software package, you can create a custom label called octocat and assign it to the runners that have the package installed. An AE hosted runner that matches all the assigned labels will then be eligible to run the job.

This example shows a job that uses multiple labels:

runs-on: [AE-runner-for-CI, octocat, linux]

These labels operate cumulatively, so an AE hosted runner's labels must match all of them for it to be eligible to process the job.

Did this doc help you?

Privacy policy

Help us make these docs great!

All GitHub docs are open source. See something that's wrong or unclear? Submit a pull request.

Make a contribution

Or, learn how to contribute.