Skip to content

Commit 3268947

Browse files
committed
updated docs
Signed-off-by: Prune <prune@lecentre.net>
1 parent e3bed04 commit 3268947

File tree

3 files changed

+33
-25
lines changed

3 files changed

+33
-25
lines changed

docs/docs/50-user-guide/60-reference-docs/30-promotion-steps/yaml-merge.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,14 @@ file and is commonly followed by a [`helm-template` step](helm-template.md).
1111
YAML files are merged in order, so the first one is the base, and all
1212
subsequent files are "overlays", modifying the default values.
1313

14+
:::note
15+
Merging is done with usual constrains:
16+
- new objects are merged
17+
- object with same name are modified
18+
- lists are replaced by latest version (no merge)
19+
- null values delete the object
20+
:::
21+
1422
## Configuration
1523

1624
| Name | Type | Required | Description |

pkg/x/promotion/runner/builtin/zz_config_types.go

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.
Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,25 @@
11
{
2-
"$schema": "https://json-schema.org/draft/2020-12/schema",
3-
"title": "YAMLMergeConfig",
4-
"type": "object",
5-
"additionalProperties": false,
6-
"properties": {
7-
"inPaths": {
8-
"type": "array",
9-
"description": "InPaths is the list of paths of YAML files to merge",
10-
"items": {
11-
"type": "string"
12-
}
13-
},
14-
"outPath": {
15-
"type": "string",
16-
"description": "OutPath is the path to the merged YAML file to create or update.",
17-
"minLength": 1
18-
},
19-
"strict": {
20-
"type": "boolean",
21-
"description": "Strict will cause the directive to fail if the input path does not exist.",
22-
"default": false
23-
}
2+
"$schema": "https://json-schema.org/draft/2020-12/schema",
3+
"title": "YAMLMergeConfig",
4+
"type": "object",
5+
"additionalProperties": false,
6+
"properties": {
7+
"inPaths": {
8+
"type": "array",
9+
"description": "InPaths is the list of paths of YAML files to merge",
10+
"items": {
11+
"type": "string"
12+
}
13+
},
14+
"outPath": {
15+
"type": "string",
16+
"description": "OutPath is the path to the merged YAML file to created or updated.",
17+
"minLength": 1
18+
},
19+
"strict": {
20+
"type": "boolean",
21+
"description": "Strict will cause the directive to fail if the input path does not exist.",
22+
"default": false
2423
}
25-
}
24+
}
25+
}

0 commit comments

Comments
 (0)