meltano / hub

The single source of truth for all Meltano plugins, including all available Singer Taps and Targets: https://hub.meltano.com
https://hub.meltano.com
50 stars 68 forks source link

feat: Do not display hidden settings #1873

Closed ReubenFrankel closed 1 month ago

ReubenFrankel commented 1 month ago

Follow-on from #1872 and related to #1418

netlify[bot] commented 1 month ago

Deploy Preview for meltano-hub ready!

Name Link
Latest commit 9c07405eaaeefdb96a0a39fe9da04d71c8140060
Latest deploy log https://app.netlify.com/sites/meltano-hub/deploys/6717c998364c6c0008eb6242
Deploy Preview https://deploy-preview-1873--meltano-hub.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

ReubenFrankel commented 1 month ago

I believe tap-googleads is currently the only plugin with any hidden settings: https://github.com/meltano/hub/blob/fb5940bebe1cdfb95a0c78e283fa901b622ba9da/_data/meltano/extractors/tap-googleads/matatika.yml#L54

https://deploy-preview-1873--meltano-hub.netlify.app/extractors/tap-googleads

edgarrmondragon commented 1 month ago

I'm having second thought on the semantics of hidden.

@ReubenFrankel do you feel like it's more intended for UIs that display (and set) Meltano plugin config? For example, for settings that may not be user-friendly.

So, I wonder if we need a deprecated flag to better reflect situations like this.

ReubenFrankel commented 1 month ago

I'm having second thought on the semantics of hidden.

@ReubenFrankel do you feel like it's more intended for UIs that display (and set) Meltano plugin config? For example, for settings that may not be user-friendly.

So, I wonder if we need a deprecated flag to better reflect situations like this.

We use hidden for that exact purpose in our UI, where some settings are hidden deliberately as they should be configured by the system only. I understand where you are coming from though, it's just odd that hidden isn't (I don't think) used anywhere in the CLI or Hub currently - I guess it was a hang-over from the old Meltano UI?

Totally fine by me to drop this, especially since it's just tap-googleads that this would "benefit". Until more plugins are actively deprecating settings, I don't think the flag is super necessary.

edgarrmondragon commented 1 month ago

@ReubenFrankel let's just keep the deprecation notice in the setting description. We can look at adding a deprecated to Meltano and the Hub plugin schema flag later on.

edgarrmondragon commented 1 month ago

I guess it was a hang-over from the old Meltano UI?

Yeah, but it also doesn't cost us much keeping it around, and is still useful for anyone trying to implementing any sort of settings UI for Meltano 🙂

ReubenFrankel commented 1 month ago

I guess it was a hang-over from the old Meltano UI?

Yeah, but it also doesn't cost us much keeping it around, and is still useful for anyone trying to implementing any sort of settings UI for Meltano 🙂

Fair enough, definitely not proposing removing it, especially since we use it 😅