diff --git a/cmd/test_data/01_basic_flow_will_pass.yaml b/cmd/test_data/01_basic_flow_will_pass.yaml index 30150db..2bb1be0 100644 --- a/cmd/test_data/01_basic_flow_will_pass.yaml +++ b/cmd/test_data/01_basic_flow_will_pass.yaml @@ -4,7 +4,7 @@ steps: description: starting the example flow command: echo args: - - Starting + - Starting on ${TERM} - label: waiting command: sleep description: sleeping for 1 second diff --git a/docs/02_yaml.md b/docs/02_yaml.md index 8f2896e..ac00aed 100644 --- a/docs/02_yaml.md +++ b/docs/02_yaml.md @@ -7,6 +7,21 @@ By default, `clingy init` will place a `.clingy.yaml` file in your present worki * `label` - a label to label the entire clingy workflow * `description` - provide a description for the clingy workflow +## Environment variables + +If you have environment variables you wish to pass into the YAML, you can do so with the following +`${ENVIRONMENT_VARIABLE}` in your YAML. For example: + +```yaml +steps: + - command: + args: + - ${ENVIRONMENT_VARIABLE_HERE} # should correctly be substituted on use +``` + +There is an example in [this file](https://github.com/madhuravius/clingy/blob/main/cmd/test_data/01_basic_flow_will_pass.yaml) +utilizing `${TERM}`. + ## Steps ### Command diff --git a/docs/example-outputs/html-simple/0.jpg b/docs/example-outputs/html-simple/0.jpg index a8f982c..e66d625 100644 Binary files a/docs/example-outputs/html-simple/0.jpg and b/docs/example-outputs/html-simple/0.jpg differ diff --git a/docs/example-outputs/html-simple/1.jpg b/docs/example-outputs/html-simple/1.jpg index 477a11c..57c9362 100644 Binary files a/docs/example-outputs/html-simple/1.jpg and b/docs/example-outputs/html-simple/1.jpg differ diff --git a/docs/example-outputs/html-simple/2.jpg b/docs/example-outputs/html-simple/2.jpg index 45d7617..9b57220 100644 Binary files a/docs/example-outputs/html-simple/2.jpg and b/docs/example-outputs/html-simple/2.jpg differ diff --git a/docs/example-outputs/html-simple/3.jpg b/docs/example-outputs/html-simple/3.jpg index 2bead2b..d9edc0d 100644 Binary files a/docs/example-outputs/html-simple/3.jpg and b/docs/example-outputs/html-simple/3.jpg differ diff --git a/docs/example-outputs/images-only/0.jpg b/docs/example-outputs/images-only/0.jpg index 0c3ca6d..3fbc45a 100644 Binary files a/docs/example-outputs/images-only/0.jpg and b/docs/example-outputs/images-only/0.jpg differ diff --git a/docs/example-outputs/images-only/1.jpg b/docs/example-outputs/images-only/1.jpg index 9fa1032..890f274 100644 Binary files a/docs/example-outputs/images-only/1.jpg and b/docs/example-outputs/images-only/1.jpg differ diff --git a/docs/example-outputs/images-only/2.jpg b/docs/example-outputs/images-only/2.jpg index 64e70b8..77afad2 100644 Binary files a/docs/example-outputs/images-only/2.jpg and b/docs/example-outputs/images-only/2.jpg differ diff --git a/docs/example-outputs/images-only/3.jpg b/docs/example-outputs/images-only/3.jpg index 39041f1..94fa44e 100644 Binary files a/docs/example-outputs/images-only/3.jpg and b/docs/example-outputs/images-only/3.jpg differ diff --git a/lib/utils.go b/lib/utils.go index 4373bb5..8beb039 100644 --- a/lib/utils.go +++ b/lib/utils.go @@ -71,6 +71,9 @@ func ParseClingyFile(logger *log.Logger, fileName string) (*ClingyTemplate, erro return nil, err } + // hydrate the yaml data from environment variables in parent context + data = []byte(os.ExpandEnv(string(data))) + var clingyData ClingyTemplate if err = yaml.Unmarshal(data, &clingyData); err != nil { return nil, err