tackle¶
Hook for calling external tackle providers.
Inputs¶
Name | Type | Default | Required | Description |
---|---|---|---|---|
input_arg | str | None | False | The input can be one of repo, file path, directory with tackle.yaml, zip file, or if left blank parent tackle file. |
checkout | str | None | False | The branch or version to checkout for repo type inputs_strings. |
no_input | bool | None | False | A boolean for if you want to suppress prompt inputs. |
latest | bool | False | True | For remote providers, use the latest commit. |
context_file | str | None | False | The file to run inside a repo input. |
extra_context | dict | None | False | Any additional context to use when calling the hook. Like existing context. |
password | SecretStr | None | False | A password to use for repo inputs. |
directory | str | None | False | The directory to run inside for repo inputs. |
find_in_parent | bool | False | True | Search for target in parent directory. Only relevant for local targets. |
override | dict | {} | True | A dictionary of keys to override. |
additional_args | Union[list, Any] | [] | True | Arguments to pass on either directly as a string or as a list of strings. |
Arguments¶
Position | Argument | Type |
---|---|---|
1 | input_arg | str |
2 | additional_args | Union[list, Any] |
Returns¶
dict | list
Examples¶
Basic¶
The most minimal implementation. Call is same as how you would call tackle from command line.
example->: tackle path/to/dir/or/github
With context¶
Sometimes you want to ship a specific context in when calling the other tackle.
example:
->: tackle path/to/dir/or/github
extra_context:
stuff: things
Remote providers¶
Providers are often remote so additional parameters are relevant in this setting.
example:
->: tackle
input_string: robcxyz/tackle-provider
checkout: dev # Branch / version to checkout
context_file: path/to/file.yaml # Path to a file within a remote provider