Updating tutorial to spike deps.bzl file #74
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
In order to use gazelle you intially need an empty deps.bzl file. I added instrustions on how to set up the file.
|
@alexeagle ping |
|
Looks fine, though I'm not sure why it's necessary over the simplicity of letting Gazelle generate |
|
@MattyKuzyk is there a different order from what the tutorial says? I have had this problem in a couple of different projects. |
alexeagle
reviewed
Feb 2, 2023
| Once you run gazelle for the first time, if you have any external Go dependencies, gazelle will update the | ||
| `deps.bzl` file to include definitions of the external dependencies. The `deps.bzl` is not required but allows | ||
| gazelle to store the projects external Go dependencies in a seperate file. Otherwise all of the external Go dependencies | ||
| are defined in the `WORKSPACE` file, and if you have a large project, you can have hundreds of extra |
| pass | ||
| ``` | ||
|
|
||
| The above Starlark code defines the function that is reference in the `WORKSPACE` file. Below is a snippet |
There was a problem hiding this comment.
is reference -> is referenced
| @@ -306,6 +305,29 @@ to the version you would like to use of Go. | |||
|
|
|||
| Next, we need a `BUILD.bazel` file in the root project directory. | |||
|
|
|||
| ## Create the intial `deps.bzl` file | |||
|
|
|||
| In order for gazelle to run properly the first time, you may need to create a `deps.bzl` file in the root directory of | |||
There was a problem hiding this comment.
It's not "to run properly" right? If you go with the default behavior then the deps go in WORKSPACE like you say later. So it's more about "if you want to keep your WORKSPACE shorter"
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.
In order to use gazelle, you initially need an empty deps.bzl file. I added instructions on how to set up the file.