GitHub Runner Groups configuration

Codebase governor lets you define GitHub Runner Groups configuration in a YAML file.

This public content is an excerpt from Flutter staff GitHub docs. It is published as a reference to show how GitHub is used for inner source at Flutter.

This page explains the format of the Codebase Governor GitHub Runner Groups configuration file. All fields are mandatory unless otherwise specified.

The file uses YAML syntax, and must have a .yml file extension. The filename must be defined as all alphanumeric characters, with the possibility of using dashes and underscores.

If you’re new to YAML and want to learn more, see “Learn YAML in Y minutes”.

owners

The owners key specifies the owner of a GitHub Runner Group. It supports two sub-keys:

  • users: An array of GitHub usernames who are the owners of the GitHub Runner Group.
  • teams: An array of GitHub team names that own the GitHub Runner Group.
owners:
  users: ["joao-silva1007"] # List of GitHub usernames of the GitHub Runner Group owners (string array)
  teams: ["maintainers-cap-codebase-governor"] # List of GitHub team names that own the GitHub Runner Group (string array)

description

The description key contains a brief description of the GitHub Runner Group. It should be a single sentence or a few short sentences, but not more than one paragraph (i.e., it shouldn’t contain line breaks).

description: "Runners used by Ops team" # Brief description of the GitHub Runner Group (string)

contacts

The contacts key provides contact information for the GitHub Runner Group. It has two sub-keys:

  • slack: An array of Slack channel names where users can reach out for inquiries about the GitHub Runner Group.
  • email: An array of email addresses for contacting the GitHub Runner Group owners team.
contacts:
  slack: ["inner-source"] # List of Slack channel names for contact (string array)
  email: ["AlphaOpsTeam@flutter.com"] # Email addresses for contact (string array)

skip_repo_usage_approval

The skip_repo_usage_approval key is optional, and indicates whether an approval is needed when adding access to a runner group from a repository configuration file, or to a defaults config in a capability. Even if set to true, an approval will still be needed if the runner group file is changed.

Available values:

  • true: The runner group doesn’t request an approval from an owner when adding to a repository/defaults config.
  • false: The runner group requests an approval from an owner when adding to a repository/defaults config.
skip_repo_usage_approval: true # (boolean)

Examples

Real GitHub Runner Group configuration examples can be viewed in the org-config repository inside the /runner-groups directory.