diff --git a/example/demo-role/README.md b/example/demo-role/README.md index 27cda2d..fb1fe8e 100644 --- a/example/demo-role/README.md +++ b/example/demo-role/README.md @@ -10,6 +10,8 @@ the default description with an annotation. - [Requirements](#requirements) - [Default Variables](#default-variables) + - [demo_bool](#demo_bool) + - [demo_bool_up](#demo_bool_up) - [demo_role_deprecated](#demo_role_deprecated) - [demo_role_deprecated_info](#demo_role_deprecated_info) - [demo_role_dict](#demo_role_dict) @@ -35,6 +37,34 @@ the default description with an annotation. ## Default Variables +### demo_bool + +#### Default value + +```YAML +demo_bool: true +``` + +#### Example usage + +```YAML +demo_bool: false +``` + +### demo_bool_up + +#### Default value + +```YAML +demo_bool_up: true +``` + +#### Example usage + +```YAML +demo_bool_up: 'False' +``` + ### demo_role_deprecated **_Deprecated_**
diff --git a/example/demo-role/defaults/main.yml b/example/demo-role/defaults/main.yml index 2487751..2830ea8 100644 --- a/example/demo-role/defaults/main.yml +++ b/example/demo-role/defaults/main.yml @@ -6,6 +6,9 @@ demo_role_unset: demo_role_empty: "" demo_role_single: "b" +# @var demo_bool:example: $ false +demo_bool: true + # @var demo_role_empty_dict:description: > # ... or valid json can be used. In this case, the json will be automatically prefixed with the annotation key # and filters like `to_nice_yaml` can be used in templates. To get it working, the json need to be prefixed with a `$`.