Skip to main content
Version: v4 (current)

Command Hooks

Inject custom shell commands into the standard build workflow at specific points.

Format​

- name: example hook
hook: |
step:
- before
commands: |
echo "hello world!"

Hook Points​

StepWhen it runs
beforeBefore the build step starts.
afterAfter the build step completes.

Usage​

Pass hooks inline via the commandHooks parameter or reference files from the .game-ci/hooks/ directory via customHookFiles.

- uses: game-ci/orchestrator@v1.0.0
with:
providerStrategy: aws
customHookFiles: my-hook
targetPlatform: StandaloneLinux64
gitPrivateToken: ${{ secrets.GITHUB_TOKEN }}

Place hook files at .game-ci/hooks/my-hook.yaml in your repository.

For running Docker containers as build steps, see Container Hooks. For ready-to-use hooks (S3, rclone, Steam), see Built-In Hooks.