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

feat!: Remove docs generation from SDK

Open hermanschaaf opened this issue 2 years ago • 3 comments

This removes docs generation from the SDK. This functionality moved to the CloudQuery CLI in https://github.com/cloudquery/cloudquery/pull/12758.

Users should now use the cloudquery tables command to achieve similar functionality as before.

Note: I decided to remove the JSON generation in this PR as well. We may bring this back in the future, but it might be in a different shape then so I think we can leave that decision for later.

hermanschaaf avatar Aug 10 '23 11:08 hermanschaaf

Codecov Report

Patch coverage: 88.88% and project coverage change: -0.32% :warning:

Comparison is base (c15b214) 48.71% compared to head (b649d2f) 48.39%.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1142      +/-   ##
==========================================
- Coverage   48.71%   48.39%   -0.32%     
==========================================
  Files          85       83       -2     
  Lines        7833     7680     -153     
==========================================
- Hits         3816     3717      -99     
+ Misses       3682     3642      -40     
+ Partials      335      321      -14     
Files Changed Coverage Δ
serve/docs.go 75.00% <66.66%> (+8.33%) :arrow_up:
docs/title_transformer.go 100.00% <100.00%> (ø)

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

codecov[bot] avatar Aug 10 '23 11:08 codecov[bot]

⏱️ Benchmark results

Comparing with c15b214a346fa8a89c929858c2623317e7048211

  • Glob-8 ns/op: 98.79 ⬇️ 1.21% decrease vs. c15b214a346fa8a89c929858c2623317e7048211

github-actions[bot] avatar Aug 10 '23 11:08 github-actions[bot]

I still think we should do this, but before merging we need to also make sure the scaffold Makefile is updated to not reference this command anymore.

hermanschaaf avatar Sep 04 '23 14:09 hermanschaaf

I'm going to close this as stale, opened https://github.com/cloudquery/cloudquery-issues/issues/2500 (internal issue) to re-visit when we have time

erezrokah avatar Oct 01 '24 08:10 erezrokah