Clarify "weaver generate" version error message. #542
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
rgrandl
approved these changes
Aug 21, 2023
mwhittaker
force-pushed
the
clarify_error_message
branch
from
dc03d0a to
d54189b
Compare
Recall that `weaver generate` generates code to check, at compile time,
that the codegen version used by `weaver generate` is the same as the
codegen version linked into the application. This check includes a
lengthy error message that is shown to the user when they try to `go
build` or `go run` with a mismatched codegen version:
```
ERROR: You generated this file with 'weaver generate' v0.20.0 (codegen
version v0.20.0). The generated code is incompatible with the version of the
github.com/ServiceWeaver/weaver module that you're using. The weaver module
version can be found in your go.mod file or by running the following command.
go list -m github.com/ServiceWeaver/weaver
We recommend updating the weaver module and the 'weaver generate' command by
running the following.
go get github.com/ServiceWeaver/weaver@latest
go install github.com/ServiceWeaver/weaver/cmd/weaver@latest
Then, re-run 'weaver generate' and re-build your code. If the problem persists,
please file an issue at https://github.com/ServiceWeaver/weaver/issues.
```
People were reading `weaver_gen.go` and seeing this error message,
thinking that something went wrong with `weaver generate`. This PR tries
to clarify the situation in two ways.
1. I moved the generated error message to the middle of `weaver_gen.go`.
Before it was at the very top, and people saw it immediately when
opening `weaver_gen.go`. Now, it's buried more in the middle, making
it less likely for people to read it.
2. I added a comment above the error message explaining that it's
nothing to worry about.
mwhittaker
force-pushed
the
clarify_error_message
branch
from
d54189b to
799081c
Compare
1 task
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.
Recall that
weaver generategenerates code to check, at compile time, that the codegen version used byweaver generateis the same as the codegen version linked into the application. This check includes a lengthy error message that is shown to the user when they try togo buildorgo runwith a mismatched codegen version:People were reading
weaver_gen.goand seeing this error message, thinking that something went wrong withweaver generate. This PR tries to clarify the situation in two ways.weaver_gen.go. Before it was at the very top, and people saw it immediately when openingweaver_gen.go. Now, it's buried more in the middle, making it less likely for people to read it.