Skip to content

Commit 2c2b639

Browse files
authored
Merge pull request #161 from hsnodgrass/bolt_tags_proposal
Add identifiers field to Bolt task metadata schema
2 parents 3722883 + 03c8e75 commit 2c2b639

File tree

2 files changed

+14
-1
lines changed

2 files changed

+14
-1
lines changed

tasks/README.md

+10-1
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,7 @@ The preferred style of the keys should be `snake_case`.
8484

8585
**remote**: Default `false`. All implementation of this task operate on a remote target using the `_target` metaparam.(rev 4)
8686

87+
**identifiers**: An arbitrary map of key-value pairs without inherent, semantic meaning to a task runner. Intended to provide identification and / or categorization of tasks that can be consumed by custom or third-party tooling.
8788

8889
#### Example Task Metadata
8990

@@ -114,7 +115,15 @@ The preferred style of the keys should be `snake_case`.
114115
{"name": "foo_sh.sh", "requirements": ["shell"], "input_method": "environment"},
115116
{"name": "foo_ps1.ps1", "requirements": ["powershell"], "files": ["my_util/files/util/win_tools.ps1"]}
116117
],
117-
"files": ["my_module/lib/puppet_x/helpful_code.rb", "kitchensink/files/task_helpers/"]
118+
"files": ["my_module/lib/puppet_x/helpful_code.rb", "kitchensink/files/task_helpers/"],
119+
"identifiers": {
120+
"tags": ["tag1", "Tag 2", "Three"],
121+
"id": "id1",
122+
"is_special": true,
123+
"nested_hash": {
124+
"also": "works"
125+
}
126+
}
118127
}
119128
```
120129

tasks/task.json

+4
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,10 @@
7777
"items": {
7878
"type": "object"
7979
}
80+
},
81+
"identifiers": {
82+
"type": "object",
83+
"description": "An arbitrary map of key-value pairs without inherent, semantic meaning to a Task Runner"
8084
}
8185
},
8286
"definitions": {

0 commit comments

Comments
 (0)