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

Adapt usage instructions to use protoc-gen-go-grpc #1755

Merged
merged 6 commits into from
Oct 16, 2020

Conversation

olivierlemasle
Copy link
Contributor

References to other Issues or PRs

N/A

Have you read the Contributing Guidelines?

Yes

Brief description of what is fixed or changed

This reflect recent changes in https://grpc.io/docs/languages/go/quickstart/ to use new protoc-gen-go-grpc.

Also remove a duplicated paragraph.

@google-cla google-cla bot added the cla: yes label Oct 14, 2020
This reflect recent changes in https://grpc.io/docs/languages/go/quickstart/
to use new protoc-gen-go-grpc.

Also remove a duplicated paragraph.
@codecov-io
Copy link

codecov-io commented Oct 14, 2020

Codecov Report

Merging #1755 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #1755   +/-   ##
=======================================
  Coverage   58.74%   58.74%           
=======================================
  Files          33       33           
  Lines        3624     3624           
=======================================
  Hits         2129     2129           
  Misses       1237     1237           
  Partials      258      258           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 1aab03c...115adc7. Read the comment docs.

README.md Outdated Show resolved Hide resolved
@johanbrandhorst
Copy link
Collaborator

Thanks a lot for this update, and for removing the duplicate installation instructions 😂. I'm worried what other merge mistakes I made 😬.

Replace github.com/golang/protobuf/protoc-gen-go by
google.golang.org/protobuf/cmd/protoc-gen-go
@olivierlemasle
Copy link
Contributor Author

@johanbrandhorst I did not find any other duplicated paragraph in the README ;-)

Copy link
Collaborator

@johanbrandhorst johanbrandhorst left a comment

Choose a reason for hiding this comment

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

Having made this switch, we should replace any uses of plugins=grpc in the repo. I can see it's still there in a few docs files. Sorry I missed it on the first review.

@olivierlemasle
Copy link
Contributor Author

I've updated the PR; I hope instructions are now correct.
I did not test Cygwin instructions, as I do not have a Windows environment at hand, but they might need to be updated.

Comment on lines +38 to +41
go get -u -v github.com/grpc-ecosystem/grpc-gateway/v2/protoc-gen-grpc-gateway
go get -u -v github.com/grpc-ecosystem/grpc-gateway/v2/protoc-gen-openapiv2
go get -u -v google.golang.org/protobuf/cmd/protoc-gen-go
go get -u -v google.golang.org/grpc/cmd/protoc-gen-go-grpc
Copy link
Collaborator

Choose a reason for hiding this comment

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

We should drop the -u -v as well, this is not how things are installed anymore.

@olivierlemasle
Copy link
Contributor Author

@johanbrandhorst I've updated the PR with the _opt format, and fixed some other small issues (missing v2 or some swagger left).

However, I did not update Cygwin instructions. I've installed Cygwin on a Windows VM to test the Cygwin instructions with an up-to-date Golang version (1.15 instead of 1.8). The majority of the instructions were now unnecessary (the errors mentioned with go get seem to be solved now with Go modules, and I did not have to adapt protoc commands). I even doubt if this page is still needed, but as I have no experience with Cygwin and even less with Go/protoc on cygwin/Windows, I do not want to handle this.

@johanbrandhorst
Copy link
Collaborator

@johanbrandhorst I've updated the PR with the _opt format, and fixed some other small issues (missing v2 or some swagger left).

However, I did not update Cygwin instructions. I've installed Cygwin on a Windows VM to test the Cygwin instructions with an up-to-date Golang version (1.15 instead of 1.8). The majority of the instructions were now unnecessary (the errors mentioned with go get seem to be solved now with Go modules, and I did not have to adapt protoc commands). I even doubt if this page is still needed, but as I have no experience with Cygwin and even less with Go/protoc on cygwin/Windows, I do not want to handle this.

😂 I can't believe you booted a windows VM to test this, that's some serious dedication. Yeah I'd be happy to remove the Cygwin instructions as well, they have surely bitrotted beyond usefulness. Thanks so much for your help!

Copy link
Collaborator

@johanbrandhorst johanbrandhorst left a comment

Choose a reason for hiding this comment

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

Some more picky comments while we're at it, thank you so much for this cleanup!

docs/_docs/usegotemplates.md Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE.md Outdated Show resolved Hide resolved
olivierlemasle and others added 2 commits October 16, 2020 12:07
Co-authored-by: Johan Brandhorst-Satzkorn <johan.brandhorst@gmail.com>
Copy link
Collaborator

@johanbrandhorst johanbrandhorst left a comment

Choose a reason for hiding this comment

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

Great, thanks so much for this Olivier 😄

@johanbrandhorst johanbrandhorst merged commit f2e74d6 into grpc-ecosystem:master Oct 16, 2020
@olivierlemasle olivierlemasle deleted the fixreadme branch October 16, 2020 10:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants