Skip to content

feat: Add more metadata to tables needed for docs generation#1129

Merged
kodiakhq[bot] merged 2 commits intomainfrom
docs-generation-metadata
Aug 8, 2023
Merged

feat: Add more metadata to tables needed for docs generation#1129
kodiakhq[bot] merged 2 commits intomainfrom
docs-generation-metadata

Conversation

@hermanschaaf
Copy link
Copy Markdown
Contributor

This adds metadata fields for table titles and parent relationships, so that this information can be sent over the wire in Arrow format. We will use this in the CLI to generate markdown and json docs for source plugins.

@github-actions
Copy link
Copy Markdown

github-actions bot commented Aug 3, 2023

⏱️ Benchmark results

Comparing with 6567043

  • Glob-8 ns/op: 100.1 (no change)

@codecov
Copy link
Copy Markdown

codecov bot commented Aug 3, 2023

Codecov Report

Patch coverage: 100.00% and project coverage change: +0.69% 🎉

Comparison is base (6567043) 47.91% compared to head (40560d1) 48.61%.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1129      +/-   ##
==========================================
+ Coverage   47.91%   48.61%   +0.69%     
==========================================
  Files          85       85              
  Lines        7808     7819      +11     
==========================================
+ Hits         3741     3801      +60     
+ Misses       3730     3684      -46     
+ Partials      337      334       -3     
Files Changed Coverage Δ
schema/arrow.go 0.00% <ø> (ø)
schema/table.go 46.01% <100.00%> (+8.82%) ⬆️

... and 1 file with indirect coverage changes

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

type Tables []*Table

// This is deprecated
// Deprecated: SyncSummary is deprecated.
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This and some other changes here were just some comment clean-up in the file to better conform to Go standards

@kodiakhq kodiakhq bot merged commit 3dbd7f3 into main Aug 8, 2023
@kodiakhq kodiakhq bot deleted the docs-generation-metadata branch August 8, 2023 09:46
hermanschaaf pushed a commit that referenced this pull request Aug 8, 2023
🤖 I have created a release *beep* *boop*
---


##
[4.3.0](v4.2.6...v4.3.0)
(2023-08-08)


### Features

* Add more metadata to tables needed for docs generation
([#1129](#1129))
([3dbd7f3](3dbd7f3))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).
kodiakhq bot pushed a commit to cloudquery/cloudquery that referenced this pull request Aug 9, 2023
…2758)

This seems to work, but marking as draft because without the change in cloudquery/plugin-sdk#1129 the docs will be missing some information. I also still need to update the code here to populate table relationship data based on the parent fields by walking the tree, so that this information will be correctly displayed in the docs.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants