Runner-specific command script executed after code is pulled, just before build executes.

Extra lines to be added verbatim to the configuration file.

Whether this file should be generated

Path of the source file.

Add a custom host-to-IP mapping.

Runner-specific command script executed after code is pulled and just after build executes.

Each attribute in this set specifies an option for a key in the plist. https://developer.apple.com/legacy/library/documentation/Darwin/Reference/ManPages/man5/launchd.plist.5.html

Disables adding the default labels

Select executor, eg. shell, docker, etc

Register to run untagged builds; defaults to true when tagList is empty.

Path of the source file.

Bind-mount a volume and create it if it doesn't exist prior to mounting.

Extra commands to run before starting buildkite.

The command hook script will replace the default implementation of running the build command.

The full path to a file which contains either

• a fine-grained personal access token (PAT),
• a classic PAT
• or a runner registration token

Changing this option or the tokenFile’s content triggers a new runner registration

Whether this file should be generated

The pre-command hook will run just before your build command runs

Each attribute in this set specifies an option for a key in the plist. https://developer.apple.com/legacy/library/documentation/Darwin/Reference/ManPages/man5/launchd.plist.5.html

When set to true Runner will only run on pipelines triggered on protected branches.

This optional key specifies what nice(3) value should be applied to the daemon.

Disable all container caching.

Each attribute in this set specifies an option for a key in the plist. https://developer.apple.com/legacy/library/documentation/Darwin/Reference/ManPages/man5/launchd.plist.5.html

The post-command hook will run after the bootstrap script has run your build commands

This required key uniquely identifies the job to launchd.

Whether this file should be generated

The group's description.

This optional key can be used to request that the datagram socket join a multicast group

OpenSSH private key

A run-time path to the key file, which is supposed to be provisioned outside of Nix store.

The pre-artifact hook will run just before artifacts are uploaded

Whitelist allowed images.

This optional key can be used to request that the datagram socket join a multicast group

What is the maximum timeout (in seconds) that will be set for job when using this Runner. 0 (default) simply means don't limit.

This optional key specifies what nice(3) value should be applied to the daemon.

A list of additional host names and/or IP numbers used for accessing the host's ssh service

The public key data for the host

This optional key can be used to request that the datagram socket join a multicast group

The post-artifact hook will run just after artifacts are uploaded

When set to true Runner will disable the possibility of using the CI_DEBUG_TRACE feature.

The pre-checkout hook will run just before your projects source code is checked out from your SCM provider

This optional key specifies what nice(3) value should be applied to the daemon.

The checkout hook script will replace the default checkout routine of the bootstrap.sh script

This required key uniquely identifies the job to launchd.

This optional key specifies that launchd should adjust its log mask temporarily to LOG_DEBUG while dealing with this job.

Modify the service

The post-checkout hook will run after the bootstrap script has checked out your projects source code.

Text of the file.

This optional key is used to control whether your job is launched once at the time the job is loaded

This optional key specifies the user to run the job as

This required key uniquely identifies the job to launchd.

The user-friendly name for the system, set in System Preferences > Sharing > Computer Name

Add programs to the buildkite-agent environment

The recommended idle time out (in seconds) to pass to the job

This optional key specifies that launchd should adjust its log mask temporarily to LOG_DEBUG while dealing with this job.

By default, nix-darwin will check that programs

Regex substring to match the app name (optional).

This optional key is used to control whether your job is launched once at the time the job is loaded

Text of the file.

This optional key specifies the user to run the job as

This optional key specifies that launchd should adjust its log mask temporarily to LOG_DEBUG while dealing with this job.

Give extended privileges to container.

Extra environment variables to set for the runner, as an attrset.

Whitelist allowed services.

This optional key causes the job to be started if any one of the listed paths are modified.

This optional key is used to control whether your job is launched once at the time the job is loaded

This optional key specifies the user to run the job as

The amount of time launchd waits before sending a SIGKILL signal

This optional key specifies what value should be passed to umask(2) before running the job

This optional key is used to specify Mach services to be registered with the Mach bootstrap sub-system

This optional key causes the job to be started every time a filesystem is mounted.

The recommended idle time out (in seconds) to pass to the job

Environment variables passed to the service's processes.

This public key is an SSH certificate authority, rather than an individual host's key.

Path of the source file.

This optional key is used to specify Mach services to be registered with the Mach bootstrap sub-system

The recommended idle time out (in seconds) to pass to the job

Text of the file.

This optional key causes the job to be started if any one of the listed paths are modified.

The amount of time launchd waits before sending a SIGKILL signal

This optional key specifies what value should be passed to umask(2) before running the job

Text of the file.

This optional key is used to specify Mach services to be registered with the Mach bootstrap sub-system

This optional key causes the job to be started every time a filesystem is mounted.

List of store paths to make accessible.

The path to the public key file for the host

This optional key causes the job to be started if any one of the listed paths are modified.

If enabled, causes the following behavior:

• Passes the --ephemeral flag to the runner configuration script
• De-registers and stops the runner with GitHub after it has processed one job
• Restarts the service after its successful exit
• On start, wipes the state directory and configures a new runner

You should only enable this option if tokenFile points to a file which contains a personal access token (PAT)

This optional key specifies the group to run the job as

The amount of time launchd waits before sending a SIGKILL signal

This optional key specifies what value should be passed to umask(2) before running the job

Environment variables passed to the service's processes.

This optional key causes the job to be started every time a filesystem is mounted.

Path of the source file.

Whether this file should be generated

Environment variables passed to the service's processes.

This optional key specifies whether the job participates in advanced communication with launchd

This optional key specifies the group to run the job as

This optional key specifies whether initgroups(3) should be called before running the job

This key was used in Mac OS X 10.4 to control whether a job was kept alive or not

This configuration file only applies to the hosts listed with this key

Attribute set of buildkite agents