Add mention of tools.go to FAQ #189
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This came up in #160, and will surely come up again. I hope the Go folks figure out something better here, but until such time...
benjaminjkraft
requested review from
csilvers,
dnerdy and
StevenACoffman
as code owners
csilvers
approved these changes
Apr 29, 2022
docs/FAQ.md
Outdated
|
|
||
| ### … genqlient fail after `go mod tidy`? | ||
|
|
||
| If genqlient fails with an error `missing go.sum entry for module providing package`, this is typically because `go mod tidy` removed its dependencies because they weren't imported by your Go module. You can read more about this in golang/go#45552; see in particular [this comment](https://github.com/golang/go/issues/45552#issuecomment-819545037). In short, if you want to be able to `go run` on newer Go you'll need to have a (blank) import of genqlient's entrypoint in a special `tools.go` file somewhere in your module so `go mod tidy` doesn't prune it. |
There was a problem hiding this comment.
I wonder if you want to give a specific example: "if genqlient puts its generated files in xxxx, your tools.go file would look like this.". Though maybe that's not so easy.
There was a problem hiding this comment.
Good idea, done.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This came up in #160, and will surely come up again. I hope the Go
folks figure out something better here, but until such time...
I have: