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

x/tools/gopls: documentation and troubleshooting guides for multi-module workspaces #41839

Closed
3 tasks
stamblerre opened this issue Oct 7, 2020 · 1 comment
Closed
3 tasks
Labels
Documentation FrozenDueToAge gopls Issues related to the Go language server, gopls. Tools This label describes issues relating to any tools in the x/tools repository.

Comments

@stamblerre
Copy link
Contributor

Working with multi-module workspaces will be tricky--users may not realize that they are using in-workspace versions of modules instead of the versions specified in their go.mod files. Other tools, such as the go command and Delve, will not see the same versions as gopls, and this will lead to further confusion. Users need thorough documentation about:

  • How the workspace module approach works
  • How to check which versions they are using of different modules (via an easily-accessible command)
  • How to generate and use the gopls.mod file when they must configure things themselves

/cc @hyangah

@stamblerre stamblerre added this to the gopls/v1.0.0 milestone Oct 7, 2020
@gopherbot gopherbot added Tools This label describes issues relating to any tools in the x/tools repository. gopls Issues related to the Go language server, gopls. Documentation labels Oct 7, 2020
@stamblerre stamblerre moved this from Critical to Documentation in vscode-go: gopls by default Nov 10, 2020
@stamblerre stamblerre added this to To Do in multi-module workspaces via automation Jan 16, 2021
@stamblerre stamblerre removed this from Documentation in vscode-go: gopls by default Jan 20, 2021
@stamblerre stamblerre added this to To Do in gopls on-deck Feb 28, 2021
@stamblerre
Copy link
Contributor Author

This is now subsumed by the go.work proposal: #45713.

multi-module workspaces automation moved this from To Do to Done Jun 28, 2021
gopls on-deck automation moved this from To Do to Done Jun 28, 2021
@stamblerre stamblerre removed this from the gopls/v1.0.0 milestone Jun 28, 2021
@stamblerre stamblerre removed this from Done in gopls on-deck Jun 28, 2021
@stamblerre stamblerre removed this from Done in multi-module workspaces Jun 28, 2021
@golang golang locked and limited conversation to collaborators Jun 28, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Documentation FrozenDueToAge gopls Issues related to the Go language server, gopls. Tools This label describes issues relating to any tools in the x/tools repository.
Projects
None yet
Development

No branches or pull requests

2 participants