Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use comments as field description #12

Merged
merged 3 commits into from
Dec 11, 2020

Conversation

chuhlomin
Copy link
Contributor

This PR adds a fields description based on a comments in proto-files (unless they have a custom option BigQueryFieldOptions.Description defined).

@sdotz
Copy link

sdotz commented Jan 29, 2019

Would love to see this reviewed and merged! We've used this great plugin, plus the code here to generate our BQ schema @ The New York Times. Our protobuf schema is used for generating lots of things in addition to the BQ schema, and so we store all of the field descriptions unobtrusively in comments. We would love to hear about any feedback/improvements as it seems pretty common thing to document .proto fields with comments. Thanks!

@chuhlomin
Copy link
Contributor Author

@yugui Could you please give a review?

@brucearctor
Copy link

Was just looking at writing some similar functionality -- any reason this hasn't gotten reviewed/merged? Other thoughts/approaches that are more sensible? @yugui , @chuhlomin ? What did you wind up using as a solution @sdotz ?

@chuhlomin
Copy link
Contributor Author

chuhlomin commented Dec 29, 2019

It seems like this repo is not actively maintained.
I ended up forking it: https://github.com/chuhlomin/protoc-gen-bq-schema
And providing Docker image: https://hub.docker.com/repository/docker/chuhlomin/protoc-gen-bq-schema

@sdotz
Copy link

sdotz commented Dec 29, 2019

I’m using the @chuhlomin fork

@brucearctor
Copy link

Awesome, thanks!

@martinroddam
Copy link

It's a great addition, but please note that there appears to be an issue with comments in RECORD fields. Raised an issue here.

@mescanne
Copy link
Collaborator

Konstantin -- we're looking to start maintaining this repo again. As you've forked it, do you have any interest in continuing to contribute? Thanks.

@mescanne
Copy link
Collaborator

I've tested out this change and am happy with it, but would like to update the examples to include descriptions. I'm merging it now and will add that on.

@mescanne mescanne merged commit ea468d3 into GoogleCloudPlatform:master Dec 11, 2020
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.

5 participants