Writing resolved Go modules as K:V JSON for external bookkeeping #1906
Conversation
|
Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). View this failed invocation of the CLA check for more information. For the most up to date status, view the checks section at the bottom of the pull request. |
Buzz-Lightyear
force-pushed
the
srini/depgraph
branch
from
10ffd1b
to
7916a0f
Compare
internal/bzlmod/go_deps.bzl
Outdated
| go_repository(**go_repository_args) | ||
|
|
||
| module_ctx.file("./resolved_go_modules.json", content=json.encode_indent(resolved_go_modules)) |
There was a problem hiding this comment.
Files written by module extensions are emitted into an unspecified temporary directory that should be removed after execution. We would need to instantiate a repo with this info or accept an absolute path via an environment variable.
There was a problem hiding this comment.
Makes sense, I'm propagating this similar to config.json used by rules_go. I was able to verify that I can access this file as @bazel_gazelle_go_repository_config//:resolved_deps.json. Would this approach work?
There was a problem hiding this comment.
I can also expose this via a separate repo rule if that's preferable. On a related note, while I can pull this into my workspace as @bazel_gazelle_go_repository_config//:resolved_deps.json, bazel mod tidy still thinks this repo is an indirect dependency and removes it from MODULE.bazel (I'm explicitly passing it in as inputs to both a build rule and a sh_binary rule). Is that perhaps a bug? If not, can I add a directive to inform bazel mod tidy that I intend to keep that use_repo call?
There was a problem hiding this comment.
Unsure why Windows build of rules_go is failing but interestingly I see Bazel warn that the repo is an indirect dependency in Gazelle's own MODULE.bazel file:
(16:03:24) WARNING: C:/b/bk-windows-xmds/bazel/bazel-gazelle/tests/bcr/go_work/MODULE.bazel:27:24: The module extension go_deps defined in @gazelle//:extensions.bzl reported incorrect imports of repositories via use_repo():
--
|
| Imported, but reported as indirect dependencies by the extension:
| bazel_gazelle_go_repository_config, org_golang_google_protobuf
There was a problem hiding this comment.
Looks like the failure was intermittent and unrelated to the change
|
The implementation looks reasonable, I'm just not sure whether this is the right way to export this information and thus don't want to commit to it yet. Could you perhaps create a discussion on this repo and use it to explain your use case in more detail? I would like to gather more feedback from the community so that we can make more informed design decisions. |
What type of PR is this?
Feature
What package or component does this PR mostly affect?
go_deps extension
What does this PR do? Why is it needed?
I'd like the go_deps module extension to expose the mapping between every Go module it bazelizes and its resolved version. This would be extremely useful for external bookkeeping (for e.g. we can easily communicate to CI systems that rely on native package manager metadata, precisely what version of each Go module was used in the build).
Which issues(s) does this PR fix?
Fixes #1905