Configuration¶
allez reads fabric-cicd's own files, config.yml and parameter.yml, from each workspace folder. It adds its own: allez.yml, and a .deploy/ folder per workspace for hooks files and overlays. Hooks of your own go in .allez/hooks/, beside the solution root. The repo structure shows where each sits; the example solution's layout shows them all together.
| File | Where | Says | Page |
|---|---|---|---|
allez.yml |
fabric/, the solution root |
The environments, the protected branches, the branch-workspace block with its git settings, and the dag that orders the deploy. |
allez.yml |
allez.yml |
fabric/<sub-folder>/ |
A patch over the root's branch-workspace block for this workspace, and the audit findings accepted as the design. |
allez.yml |
dag: |
in the root allez.yml |
One node per config.yml or overlay, with depends_on, hooks files and an environment scope. |
Deployment dag |
<purpose>.hooks.yml |
fabric/<sub-folder>/.deploy/hooks/ |
The steps a dag node runs before or after its publish. | Hooks files |
<name>.config.yml |
fabric/<sub-folder>/.deploy/config-overlay/ |
A partial config.yml that narrows one dag node's publish. |
Overlays |
config.yml |
fabric/<sub-folder>/ |
fabric-cicd's: which workspace each environment deploys to, the item scope, the publish and unpublish rules. | config.yml |
parameter.yml |
fabric/<sub-folder>/ |
fabric-cicd's: the values to rewrite per environment. A replace_value may carry a $allez.* token. |
parameter.yml, $allez.* variables |
<action>.py |
.allez/hooks/, beside fabric/ |
A hook of your own, named by a step's action. |
Writing your own |
Every allez.yml and hooks file is checked when it loads, before any fab call: an unknown key, an undeclared environment or a missing file stops the run with an error that names the file and the key (rejected at load). allez.schema.json gives the editor the same keys as completion and hover text (editor support).
A value that differs per environment is written once as an Override Map, {default: …, <env>: …}, or scoped with an environments: list (environment resolution). Only branch-workspace and dag nodes resolve per environment; config.yml and parameter.yml have fabric-cicd's own per-environment keys.