This is an automated email from the ASF dual-hosted git repository. heneveld pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/brooklyn-docs.git
commit ae596c3833e62bc507bf071e5fd1f9441b4e08f1 Author: Alex Heneveld <[email protected]> AuthorDate: Fri May 19 15:48:13 2023 +0100 add doc for colon trick, and tidies --- guide/blueprints/workflow/common.md | 2 ++ guide/blueprints/workflow/nested-workflow.md | 2 +- guide/blueprints/workflow/steps/steps.yaml | 2 +- 3 files changed, 4 insertions(+), 2 deletions(-) diff --git a/guide/blueprints/workflow/common.md b/guide/blueprints/workflow/common.md index c790833b..bfc4fba8 100644 --- a/guide/blueprints/workflow/common.md +++ b/guide/blueprints/workflow/common.md @@ -50,6 +50,8 @@ steps: not: { equals: true } ``` +Care should be taken when using `:` in a step with shorthand. YAML will parse it as a map if it is not quoted in YAML. However at runtime, if the step looks like it came from an accidental colon causing a map, it will be reverted to a string with the colon re-introduced, so you can write steps with shorthand `- log Your name is: ${name}`. + All steps support a number of common properties, described below. ### Explicit IDs and Name diff --git a/guide/blueprints/workflow/nested-workflow.md b/guide/blueprints/workflow/nested-workflow.md index ee64804c..e5c68bcd 100644 --- a/guide/blueprints/workflow/nested-workflow.md +++ b/guide/blueprints/workflow/nested-workflow.md @@ -182,7 +182,7 @@ boolean isDefaultIdempotent(); ``` The first of these does the work of the step, resolving inputs and accessing context as needed via `context`. -The second handles providing a cusotm shorthand, as described above; +The second handles providing a custom shorthand, as described above; it can call to a superclass method `populateFromShorthandTemplate(TEMPLATE, value)` with the `TEMPLATE` for the class, if shorthand is to be supported. Finally, the third returns whether the step is idempotent, that is if the custom step is interrupted, diff --git a/guide/blueprints/workflow/steps/steps.yaml b/guide/blueprints/workflow/steps/steps.yaml index 4242716b..7212d032 100644 --- a/guide/blueprints/workflow/steps/steps.yaml +++ b/guide/blueprints/workflow/steps/steps.yaml @@ -529,7 +529,7 @@ - section_name: General Purpose section_intro: | - A few other miscellaneous step types don't fit into the other categories. + Miscellaneous step types that don't fit into the other categories. steps: - name: log
