Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: fix another incorrect substitution doc #612

Merged
merged 1 commit into from
Apr 16, 2024
Merged

fix: fix another incorrect substitution doc #612

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 7 additions & 5 deletions doc/stacker_yaml.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,17 @@
## The `stacker.yaml` file

When doing a `stacker build`, the behavior of stacker is specified by the yaml
directives below. In addition to these, stacker allows variable substitions of
several forms. For example, a line like:
directives below.

$ONE ${{TWO}} ${{THREE:3}}
Before the yaml is parsed, stacker performs substitution on placeholders in the
file of the format `${{VAR}}` or `${{VAR:default}}`. For example, a line like:

When run with `stacker build --substitute ONE=1 --substitute TWO=2` is
${{ONE}} ${{TWO:3}}

When run with `stacker build --substitute ONE=1` is
processed in stacker as:

1 2 3
1 3

In order to avoid conflict with bash or POSIX shells in the `run` section,
only placeholders with two braces are supported, e.g. `${{FOO}}`.
Expand Down
Loading