Skip to content

feat!: Remove docs generation from SDK#1142

Closed
hermanschaaf wants to merge 3 commits intomainfrom
remove-docs-generator
Closed

feat!: Remove docs generation from SDK#1142
hermanschaaf wants to merge 3 commits intomainfrom
remove-docs-generator

Conversation

@hermanschaaf
Copy link
Copy Markdown
Contributor

@hermanschaaf hermanschaaf commented Aug 10, 2023

This removes docs generation from the SDK. This functionality moved to the CloudQuery CLI in cloudquery/cloudquery#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.

@github-actions github-actions bot added breaking and removed feat labels Aug 10, 2023
@hermanschaaf hermanschaaf marked this pull request as draft August 10, 2023 11:02
@codecov
Copy link
Copy Markdown

codecov bot commented Aug 10, 2023

Codecov Report

Patch coverage: 88.88% and project coverage change: -0.32% ⚠️

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%) ⬆️
docs/title_transformer.go 100.00% <100.00%> (ø)

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@hermanschaaf hermanschaaf marked this pull request as ready for review August 10, 2023 11:06
@github-actions
Copy link
Copy Markdown

github-actions bot commented Aug 10, 2023

⏱️ Benchmark results

Comparing with c15b214

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

@hermanschaaf
Copy link
Copy Markdown
Contributor Author

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.

@erezrokah
Copy link
Copy Markdown
Member

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 erezrokah closed this Oct 1, 2024
@erezrokah erezrokah mentioned this pull request Apr 28, 2025
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants