Section
Configuration
The Deployfile.yml + deploy/<stage>.yml reference - every field, the merge model, hosts, tasks, scripts, hooks, templating, and plugins.
Overview
File layout, the two-file merge model, sharing config with include:, the top-level field index, the app block, and the merge rules.
→
Hosts
Hosts, roles, SSH connection settings, local execution mode, inventory-vs-deploy targets, and the unreachable-host policy.
→
Linked files & dirs
Files and directories kept in shared/ and symlinked into every release so config and state persist across deploys.
→
Vars & envs
vars (template + env values) vs envs (the shell environment), and how to mark secrets sensitive so they're redacted everywhere.
→
Tasks
Named units of work - cmds, scripts, deps, roles, working directory, per-task env, and the targeting/behavior flags.
→
Scripts
Run shell scripts from a task - by file name, by absolute path, or inline - streamed to the interpreter over stdin.
→
Task state
Capture a task's stdout (json/text/lines) and read it from later tasks in the same run as {{ .tasks.<name> }}.
→
Hooks & phases
Attach tasks to the deploy lifecycle with before/after hooks, the special deploy:failed and deploy:rollback hooks, and phase replacement.
→
Templating & variables
Go templates + sprig in commands and scripts, plus the deploy context exported to the shell as $ENV vars - with the full variable table.
→
AWS Plugin
The AWS plugin - EC2 inventory, ASG refresh/rollback, AMI create/cleanup, SSM/Secrets Manager - plus credentials and writing your own.
→