Configure the kind of a setting through prompt when adding a custom plugin
Problem to solve
When using meltano add --custom <type> <name>
, there is no way to specify a setting kind
through the prompt.
Target audience
Users developing custom Meltano plug-ins
Further details
Automated workflows that use meltano add --custom <type> <name>
have no way to configure a setting kind
if the plugin requires it, other than editing meltano.yml
manually or with a custom script.
Proposal
Have not thought about this in too much detail, but it could be some kind of custom syntax, such as:
-
<setting>:<kind>
(single setting) -
<setting1>:<kind1>,<setting2>:<kind2> ...
(multiple settings, comma-separated)
kind
of type string
could be implicit, such that just specifying <setting>
provides type string
.
Example of modified settings prompt:
Specify the tap's supported settings (`config.json` keys)
Nested properties can be represented using the `.` separator,
e.g. `auth.username` for `{ "auth": { "username": value } }`.
To find out what settings a tap supports, reference its documentation.
Multiple setting names (keys) can be separated using commas.
Default: no settings
(settings) [[]]: files:array,id:int,name
What does success look like, and how can we measure that?
The setting kind
is successfully assigned to the setting once the prompt completes.
Regression test
(Ensure the feature doesn't cause any regressions)
-
Write adequate test cases and submit test results -
Test results should be reviewed by a person from the team
Edited by ReubenFrankel