Buildkite Agent hooks

What's a hook?

A hook is a script executed or sourced by the Buildkite agent at a specific point in the job lifecycle. You can use hooks to extend or override the built-in behavior of an agent. Hooks are generally shell scripts, which the agent then executes or sources.

Hook scopes

You can define hooks in the following locations:

• In the file system of the agent machine (called agent hooks, or more rarely global hooks).
• In your pipeline's repository (called repository hooks, or more rarely local hooks).
• In plugins applied to steps.

For example, you could define an agent-wide checkout hook that spins up a fresh git clone on a new build machine, a repository pre-command hook that sets up repository-specific environment variables, or a plugin environment hook that fetches API keys from a secrets storage service.

There are two categories of hooks:

• Agent lifecycle
• Job lifecycle

Agent lifecycle hooks are executed by the Buildkite agent as part of the agent's lifecycle. For example, the pre-bootstrap hook is executed before starting a job's bootstrap process, and the agent-shutdown hook is executed before the agent process terminates.

Job lifecycle hooks are sourced (see "A note on sourcing" for specifics) by the Buildkite bootstrap in the different job phases. They run in a per-job shell environment, and any exported environment variables are carried to the job's subsequent phases and hooks. For example, the environment hook can modify or export new environment variables for the job's subsequent checkout and command phases. Shell options set by individual hooks, such as set -e -o pipefail, are not carried over to other phases or hooks.

Hook locations

You can define hooks in the following locations:

• Agent hooks: These exist on the agent file system in a directory created by your agent installer and configured by the hooks-path setting. You can define both agent lifecycle and job lifecycle hooks in the agent hooks location. Job lifecycle hooks defined here will run for every job the agent receives from any pipeline.
• Repository hooks: These exist in your pipeline repository's .buildkite/hooks directory and can define job lifecycle hooks. Job lifecycle hooks defined here will run for every pipeline that uses the repository. In scenarios where the current working directory is modified as part of the command or a post-command hook, this modification will cause these hooks to fail as the .buildkite/hooks directory can no longer be found in its new directory path. Ensure that the working directory is not modified to avoid these issues.
• Plugin hooks: These are provided by plugins you've included in your pipeline steps and can define job lifecycle hooks. Job lifecycle hooks defined by a plugin will only run for the step that includes them. Plugins can be vendored (if they are already present in the repository and included using a relative path) or non-vendored (when they are included from elsewhere), which affects the order they are run in.

Agent hooks

Every agent installer creates a hooks directory containing a set of sample hooks. You can find the location of your agent hooks directory in your platform's installation documentation.

To get started with agent hooks, copy the relevant example script and remove the .sample file extension.

See agent lifecycle hooks and job lifecycle hooks for the hook types that you can define in the agent hooks directory.

Repository hooks

Repository hooks allow you to execute repository-specific scripts. Repository hooks live alongside your repository's source code under the .buildkite/hooks directory.

To get started, create a shell script in .buildkite/hooks named post-checkout. It will be sourced and run after your repository has been checked out as part of every job for any pipeline that uses this repository.

You can define any of the job lifecycle hooks whose Order includes Repository.

Plugin hooks

Plugin hooks allow plugins you've defined in your Pipeline Steps to override the default behavior.

See the plugin documentation for how to implement plugin hooks and job lifecycle hooks for the list of hook types that a plugin can define.

Polyglot hooks

By default, hooks must be shell scripts. However, with the polyglot-hooks experiment on agents running version v3.47.0, hooks are significantly more flexible and can be written in the programming language of your choice.

In addition to the regular shell script hooks, polyglot hooks enable you to run two more types of hooks:

• Interpreted hooks: Hooks that are run by an interpreter, such as Python, Ruby, or Node.js. These hooks are run in the same way as shell script hooks, but are executed by the appropriate interpreter instead of by the shell. These hooks must have a valid shebang as the first line of the hook. For example, #!/usr/bin/python3 or #!/usr/bin/env ruby.
• Binary hooks: Binary executables produced by compiled languages such as Go, Rust, or C++. These hooks are run in the same way as shell script hooks, but are executed directly by the operating system. These hooks must be compiled for the correct operating system and architecture, and be executable by the agent user.

Polyglot hooks are run transparently by the agent, and are not distinguished from shell script hooks in the logs or the Buildkite dashboard. The agent will automatically detect the type of hook–whether it's a shell script, an interpreted hook, or a binary–and run it appropriately. All you need to do is place your hook in the correct location and ensure it's executable.

Extra environment variables

When polyglot hooks are called, the following extra environment variables are set:

• BUILDKITE_HOOK_PHASE - The lifecycle phase of the hook being run. For example, environment or post-checkout. See job lifecycle hooks for the full list of phases. This enables the hook to determine the phase it's running in, allowing you to use the same hook for multiple phases.
• BUILDKITE_HOOK_PATH - The path to the hook being run. For example, /path/to/my-hook.
• BUILDKITE_HOOK_SCOPE - The scope of the hook being run. For example, global, local, or plugin.

Caveats

Polyglot hook usage comes with the following caveats:

• Interpreted hooks are not supported on Windows.
• Hooks must not have a file extension–except on Windows, where binary hooks must have the .exe extension.
• For interpreted hooks, the specified interpreter must already be installed on the agent machine. The agent won't install the interpreter or any package dependencies for you.
• Unlike shell hooks, environment variable changes are not automatically captured from polyglot hooks. If you want to modify the job's environment, you'll have to use the Job API.

Agent lifecycle hooks

Creating agent lifecycle hooks

The Buildkite agent executes agent lifecycle hooks. These hooks can only be defined in the agent hooks-path directory. Agent lifecycle hooks can be executables written in any programming language. On Unix-like systems (such as Linux and macOS), hooks must be files that are executable by the user the agent is running as.

Use agent lifecycle hooks to prepare for or clean up after all jobs that may run. For example, use pre-bootstrap to block unwanted jobs from running or use agent-shutdown to tear down a service after all jobs are finished. If your hook uses details about any individual job to run, prefer job lifecycle hooks for those tasks instead.

The agent exports few environment variables to agent lifecycle hooks. Read the agent lifecycle hooks table for details on the interface between the agent and each hook type.

Job lifecycle hooks

The following is a complete list of available job hooks, and the order in which they are run as part of each job:

Each command job defined in a pipeline's pipeline.yml file runs independently of one another. Therefore, each defined hook will run for every one of these command jobs.

When defining multiple command items in a step using the commands attribute, such as the pipeline.yml example in Command step attributes, then each item in the commands list is concatenated together and run as a single command. Therefore, a given hook will only run once for a given commands job consisting of multiple command items.

Hook failure behavior

When a pipeline's job runs, the first point of failure causes the entire job to fail and terminate.

In the table above, if any of the hooks above command (from pre-bootstrap to pre-command, inclusive) fails with a non-zero exit code, then the command phase of the pipeline job will not run.

Since all the hooks below command (from post-command to pre-exit, inclusive) run after the command phase of the pipeline job, then any non-zero exit code failure in these hooks would still fail the entire job. Be aware, however, that any actions in the command phase of the pipeline job would have already run successfully.

Hook exceptions

Typically, if there are multiple hooks of the same type, all of them will be run (in the order shown in the table).

As of Agent v3.15.0, if multiple checkout or command hooks are found, only the first (of each type) will be run. This does not apply to other hook types.

However, for legacy compatibility, there is an exception with plugins. All checkout or command hooks provided by plugins will run in the order the plugins are specified, meaning multiple checkout and command hooks can run. Note that checkout hooks and command hooks provided by plugins will prevent any repository or agent hooks of the same type from running.

Creating job lifecycle hooks

Job lifecycle hooks are sourced for every job an agent accepts. Use job lifecycle hooks to prepare for jobs, override the default behavior, or clean up after jobs that have finished. For example, use the environment hook to set a job's environment variables or the pre-exit hook to delete temporary files and remove containers. If your hook is related to the startup or shutdown of the agent, consider agent lifecycle hooks for those tasks instead.

Job lifecycle hooks have access to all the standard Buildkite environment variables.

Job lifecycle hooks are copied to $TMPDIR directory and sourced by the agent's default shell. This has a few implications:

• $BASH_SOURCE contains the location the hook is sourced from.
• $0 contains the location of the copy of the script that is running from $TMPDIR.

To write job lifecycle hooks in another programming language, you need to execute them from within the shell script, and explicitly pass any Buildkite environment variables you need to the script when you call it.

The following is an example of an environment hook which exports a GitHub API key for the pipeline's release build step:

set -eu
echo '--- :house_with_garden: Setting up the environment'

export GITHUB_RELEASE_ACCESS_KEY='xxx'

Job hooks on Windows

Buildkite defaults to using the Batch shell on Windows. Buildkite agents running on Windows require that either:

• The hooks files have a .bat extension, and be written in Windows Batch, or
• The agent shell option points to the PowerShell or PowerShell Core executable, and the hooks files are written in PowerShell. PowerShell hooks are supported in Buildkite agent version 3.32.3 and above.

An example of a Windows environment.bat hook:

@ECHO OFF
ECHO "--- :house_with_garden: Setting up the environment"
SET GITHUB_RELEASE_ACCESS_KEY='xxx'

Hooks on Buildkite hosted agents

Agent hooks are supported on Buildkite hosted agents for Linux.

Currently, Buildkite hosted agents for macOS do not support agent hooks. Instead, use either repository- or plugin-based hooks with these types of agents.