Prevent go.mod file pollution with development dependencies
#85
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
Previously when installing development dependencies through "mage", the `go.mod` file was updated to include the installed packages since this the default behavior of the `go get` command when running in "module" mode. To prevent the pollution of the project's Go module definition the "module" mode has been disabled when installing the dev/build packages. This is a necessary workaround until the Go toolchain is able to install packages globally without updating the module file when the `go get` command is run from within the project root directory. See golang/go#30515 for more details and proposed solutions that might be added to Go's build tools in future versions. Epic GH-33 GH-82
arcticicestudio
changed the base branch from
develop
to
epic/gh-33-the-way-to-go
svengreb
approved these changes
Oct 12, 2019
arcticicestudio
deleted the
improvement/gh-82-prevent-go-mod-pollution-dev-deps
branch
This was referenced Oct 12, 2019
arcticicestudio
added a commit
that referenced
this pull request
Oct 12, 2019
The workaround implemented in GH-82 (PR GH-85) worked fine, but due to the explicitly disabled "module" mode it was not possible to define pinned dependency versions but only using the normal `go get` behavior to build the repositories default branch. A better workaround is to run the `go get` command for development & build dependencies/packages outside of the project's root directory. Therefore the `go.mod` file is not in scope for the `go get` command and is therefore not updated. In order to use pinned versions the `GO1111MODULE=on` environment variable is explicitly set when running the `go get` command. See golang/go#30515 for more details and proposed solutions that might be added to Go's build tools in future versions. Epic GH-33 GH-88
arcticicestudio
added a commit
that referenced
this pull request
Oct 12, 2019
The workaround implemented in GH-82 (PR GH-85) worked fine, but due to the explicitly disabled "module" mode it was not possible to define pinned dependency versions but only using the normal `go get` behavior to build the repositories default branch. A better workaround is to run the `go get` command for development & build dependencies/packages outside of the project's root directory. Therefore the `go.mod` file is not in scope for the `go get` command and is therefore not updated. In order to use pinned versions the `GO1111MODULE=on` environment variable is explicitly set when running the `go get` command. See golang/go#30515 for more details and proposed solutions that might be added to Go's build tools in future versions. Epic GH-33 Resolves GH-88
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.
Resolves #82