plugin-sdk icon indicating copy to clipboard operation
plugin-sdk copied to clipboard

feat!: Remove reflect methods

Open bbernays opened this issue 7 months ago โ€ข 1 comments

Summary


Use the following steps to ensure your PR is ready to be reviewed

  • [ ] Read the contribution guidelines ๐Ÿง‘โ€๐ŸŽ“
  • [ ] Run go fmt to format your code ๐Ÿ–Š
  • [ ] Lint your changes via golangci-lint run ๐Ÿšจ (install golangci-lint here)
  • [ ] Update or add tests ๐Ÿงช
  • [ ] Ensure the status checks below are successful โœ…

bbernays avatar Apr 24 '25 14:04 bbernays

Maybe we can bring back #1142? That should resolve cloudquery/cloudquery-issues#2500

I have no problem with this

bbernays avatar Apr 28 '25 15:04 bbernays

We'll need to do a follow up in the FIPS plugins but I think that's fine. One thing I'm not sure about is classifying this as a breaking change, that would require a bit of work for our plugins to do the major version bump. The potential breaking change here is the grpcnotrace flag, which plugins authors can override now

I am fine making it a non-breaking change, but the reason why it is breaking change is because it removes the ability for the plugin to generate markdown docs...

https://github.com/cloudquery/plugin-sdk/blob/948fce1ea2c52dc81cf8ea921f37ac131f9ce000/serve/docs.go#L46-L51

bbernays avatar May 16 '25 14:05 bbernays

but the reason why it is breaking change is because it removes the ability for the plugin to generate markdown docs...

Ah yeah that hasn't been used for a long time I believe and we were the only users

erezrokah avatar May 16 '25 14:05 erezrokah

So just to be clear you are good with me marking this as a non breaking change?

cc @murarustefaan

bbernays avatar May 16 '25 14:05 bbernays

BTW https://github.com/cloudquery/plugin-sdk/pull/1142 removes docs generation altogether, do we need JSON docs? Can be done in another PR

erezrokah avatar May 16 '25 14:05 erezrokah

So just to be clear you are good with me marking this as a non breaking change?

Yes, I do not think the potential impact this change has warrants a major SDK version bump.

... do we need JSON docs? ...

Nope. But since the changeset for removing doc generation completely is bigger, we'd be better off having that in a separate PR.

murarustefaan avatar May 16 '25 16:05 murarustefaan