Skip to content
This repository has been archived by the owner on Aug 16, 2022. It is now read-only.

Improve Doc Generation #294

Merged
merged 8 commits into from
Nov 24, 2021
Merged

Improve Doc Generation #294

merged 8 commits into from
Nov 24, 2021

Conversation

bbernays
Copy link
Contributor

Ran into issues when changing a table name where the github checks kept failing because the old table file was never being deleted. By clearing out all of the files for each run this will avoid that issue

@bbernays bbernays requested a review from roneli November 23, 2021 20:46
Copy link
Member

@yevgenypats yevgenypats left a comment

Choose a reason for hiding this comment

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

looks good few minor comments

docs/docs.go Outdated Show resolved Hide resolved
@roneli
Copy link
Contributor

roneli commented Nov 24, 2021

Would add this feature to the SDK as well so all providers can have this feature.

@bbernays
Copy link
Contributor Author

Would add this feature to the SDK as well so all providers can have this feature.

I originally thought to just add it to the SDK but was concerned about adding destructive actions... wasn't sure if the directory was always 100% dynamically generated or if there could be manual additions

@roneli
Copy link
Contributor

roneli commented Nov 24, 2021

Would add this feature to the SDK as well so all providers can have this feature.

I originally thought to just add it to the SDK but was concerned about adding destructive actions... wasn't sure if the directory was always 100% dynamically generated or if there could be manual additions

We can add it as an optional flag delete_old bool to the doc generator. I see it useful for all other providers we support.

@bbernays
Copy link
Contributor Author

@roneli - Created an issue on the cq-provider-sdk to implement this functionality

Copy link
Contributor

@roneli roneli left a comment

Choose a reason for hiding this comment

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

LGTM, added two suggestions

docs/docs.go Outdated Show resolved Hide resolved
docs/docs.go Outdated Show resolved Hide resolved
@roneli roneli merged commit a9cecc0 into cloudquery:main Nov 24, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants