Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add identifiers field to Bolt task metadata schema #161

Merged
merged 1 commit into from
Aug 7, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion tasks/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,7 @@ The preferred style of the keys should be `snake_case`.

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

**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.

#### Example Task Metadata

Expand Down Expand Up @@ -114,7 +115,15 @@ The preferred style of the keys should be `snake_case`.
{"name": "foo_sh.sh", "requirements": ["shell"], "input_method": "environment"},
{"name": "foo_ps1.ps1", "requirements": ["powershell"], "files": ["my_util/files/util/win_tools.ps1"]}
],
"files": ["my_module/lib/puppet_x/helpful_code.rb", "kitchensink/files/task_helpers/"]
"files": ["my_module/lib/puppet_x/helpful_code.rb", "kitchensink/files/task_helpers/"],
"identifiers": {
"tags": ["tag1", "Tag 2", "Three"],
"id": "id1",
"is_special": true,
"nested_hash": {
"also": "works"
}
}
}
```

Expand Down
4 changes: 4 additions & 0 deletions tasks/task.json
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,10 @@
"items": {
"type": "object"
}
},
"identifiers": {
"type": "object",
"description": "An arbitrary map of key-value pairs without inherent, semantic meaning to a Task Runner"
}
},
"definitions": {
Expand Down
Loading