Make # gazelle:proto file work without needing to set different option go_package in .proto files
#1765
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
…t.go file (bazel-contrib#1597) * add a go_test directive to enable generating go_test targets per _test.go file * address comments * add new tests for updating to per-file mode --------- Co-authored-by: Fabian Meumertzheim <fabian@meumertzhe.im>
|
@linzhp FYI -- let @jeromep-stripe know what you think. |
|
Ping on this @linzhp -- let us know what we can do to help. |
|
Oh, sorry, I missed the previous ping. Let me take a look later this week. |
|
(Gentle nudge on this; hope you have a good weekend, happy to discuss if you'd like.) |
linzhp
reviewed
May 5, 2024
|
Some minor comments. LGTM overall. I also tested it in Uber's Go repo. |
|
@linzhp ty for the review, I addressed your comments! |
linzhp
approved these changes
May 18, 2024
renovate bot
referenced
this pull request
in kreempuff/rules_unreal_engine
Aug 1, 2024
[](https://renovatebot.com) This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [bazel_gazelle](https://togithub.com/bazelbuild/bazel-gazelle) | http_archive | minor | `v0.36.0` -> `v0.38.0` | --- > [!WARNING] > Some dependencies could not be looked up. Check the Dependency Dashboard for more information. --- ### Release Notes <details> <summary>bazelbuild/bazel-gazelle (bazel_gazelle)</summary> ### [`v0.38.0`](https://togithub.com/bazelbuild/bazel-gazelle/releases/tag/v0.38.0) [Compare Source](https://togithub.com/bazelbuild/bazel-gazelle/compare/v0.37.0...v0.38.0) #### What's Changed - Add support for `include()` in `MODULE.bazel` by [@​fmeum](https://togithub.com/fmeum) in [https://github.com/bazelbuild/bazel-gazelle/pull/1810](https://togithub.com/bazelbuild/bazel-gazelle/pull/1810) - feat: gazelle_test test rule by [@​hunshcn](https://togithub.com/hunshcn) in [https://github.com/bazelbuild/bazel-gazelle/pull/1785](https://togithub.com/bazelbuild/bazel-gazelle/pull/1785) - Handle arm64 host platform for MacOS by [@​smocherla-brex](https://togithub.com/smocherla-brex) in [https://github.com/bazelbuild/bazel-gazelle/pull/1817](https://togithub.com/bazelbuild/bazel-gazelle/pull/1817) - go_repository: add 'clean' build_file_generation by [@​TvdW](https://togithub.com/TvdW) in [https://github.com/bazelbuild/bazel-gazelle/pull/1802](https://togithub.com/bazelbuild/bazel-gazelle/pull/1802) - fix: support leading ./ in .bazelignore by [@​jbedard](https://togithub.com/jbedard) in [https://github.com/bazelbuild/bazel-gazelle/pull/1828](https://togithub.com/bazelbuild/bazel-gazelle/pull/1828) - Restore compatibility with Go 1.18 by [@​fmeum](https://togithub.com/fmeum) in [https://github.com/bazelbuild/bazel-gazelle/pull/1833](https://togithub.com/bazelbuild/bazel-gazelle/pull/1833) - Remove reliance on specific canonical repo name scheme by [@​fmeum](https://togithub.com/fmeum) in [https://github.com/bazelbuild/bazel-gazelle/pull/1835](https://togithub.com/bazelbuild/bazel-gazelle/pull/1835) - temporarily disable `//internal:bazel_test` on Mac to fix CI by [@​tyler-french](https://togithub.com/tyler-french) in [https://github.com/bazelbuild/bazel-gazelle/pull/1842](https://togithub.com/bazelbuild/bazel-gazelle/pull/1842) - update readmes for latest release by [@​tyler-french](https://togithub.com/tyler-french) in [https://github.com/bazelbuild/bazel-gazelle/pull/1840](https://togithub.com/bazelbuild/bazel-gazelle/pull/1840) - \[Gazelle] Fix Duplicate Load Bug by [@​ckilian867](https://togithub.com/ckilian867) in [https://github.com/bazelbuild/bazel-gazelle/pull/1841](https://togithub.com/bazelbuild/bazel-gazelle/pull/1841) - \[Proto] Require space between 'service' and service name in regex matching by [@​ckilian867](https://togithub.com/ckilian867) in [https://github.com/bazelbuild/bazel-gazelle/pull/1845](https://togithub.com/bazelbuild/bazel-gazelle/pull/1845) - \[Proto] Keep track of the names of Services, Messages, and Enums by [@​ckilian867](https://togithub.com/ckilian867) in [https://github.com/bazelbuild/bazel-gazelle/pull/1844](https://togithub.com/bazelbuild/bazel-gazelle/pull/1844) - Always check files in generation tests by [@​Whoaa512](https://togithub.com/Whoaa512) in [https://github.com/bazelbuild/bazel-gazelle/pull/1847](https://togithub.com/bazelbuild/bazel-gazelle/pull/1847) - Support label using regexp in directive `gazelle:resolve_regexp` by [@​lkassar-stripe](https://togithub.com/lkassar-stripe) in [https://github.com/bazelbuild/bazel-gazelle/pull/1822](https://togithub.com/bazelbuild/bazel-gazelle/pull/1822) - Add `external/...` prefix to `${SRCDIR}` in external repos by [@​fmeum](https://togithub.com/fmeum) in [https://github.com/bazelbuild/bazel-gazelle/pull/1850](https://togithub.com/bazelbuild/bazel-gazelle/pull/1850) - feat(tools): add a tool to automate the generation of go_deps overrides by [@​tyler-french](https://togithub.com/tyler-french) in [https://github.com/bazelbuild/bazel-gazelle/pull/1677](https://togithub.com/bazelbuild/bazel-gazelle/pull/1677) - prepare release 0.38 by [@​tyler-french](https://togithub.com/tyler-french) in [https://github.com/bazelbuild/bazel-gazelle/pull/1849](https://togithub.com/bazelbuild/bazel-gazelle/pull/1849) #### New Contributors - [@​smocherla-brex](https://togithub.com/smocherla-brex) made their first contribution in [https://github.com/bazelbuild/bazel-gazelle/pull/1817](https://togithub.com/bazelbuild/bazel-gazelle/pull/1817) - [@​TvdW](https://togithub.com/TvdW) made their first contribution in [https://github.com/bazelbuild/bazel-gazelle/pull/1802](https://togithub.com/bazelbuild/bazel-gazelle/pull/1802) - [@​ckilian867](https://togithub.com/ckilian867) made their first contribution in [https://github.com/bazelbuild/bazel-gazelle/pull/1841](https://togithub.com/bazelbuild/bazel-gazelle/pull/1841) - [@​lkassar-stripe](https://togithub.com/lkassar-stripe) made their first contribution in [https://github.com/bazelbuild/bazel-gazelle/pull/1822](https://togithub.com/bazelbuild/bazel-gazelle/pull/1822) **Full Changelog**: bazel-contrib/bazel-gazelle@v0.37.0...v0.38.0 ### [`v0.37.0`](https://togithub.com/bazelbuild/bazel-gazelle/releases/tag/v0.37.0) [Compare Source](https://togithub.com/bazelbuild/bazel-gazelle/compare/v0.36.0...v0.37.0) #### What's Changed - Apply map_kind to args as well as rule kinds by [@​illicitonion](https://togithub.com/illicitonion) in [https://github.com/bazelbuild/bazel-gazelle/pull/1722](https://togithub.com/bazelbuild/bazel-gazelle/pull/1722) - Add a pointer to bzlmod guide by [@​sluongng](https://togithub.com/sluongng) in [https://github.com/bazelbuild/bazel-gazelle/pull/1781](https://togithub.com/bazelbuild/bazel-gazelle/pull/1781) - \[Extraction] prep for go.mod & go.work FilePath ReplaceDirective work by [@​stefanpenner](https://togithub.com/stefanpenner) in [https://github.com/bazelbuild/bazel-gazelle/pull/1780](https://togithub.com/bazelbuild/bazel-gazelle/pull/1780) - \[cmd/fetch_repo] make cache corruption failures more clear by [@​tyler-french](https://togithub.com/tyler-french) in [https://github.com/bazelbuild/bazel-gazelle/pull/1782](https://togithub.com/bazelbuild/bazel-gazelle/pull/1782) - Nit: pass -modcacherw in exec.Command. by [@​hauserx](https://togithub.com/hauserx) in [https://github.com/bazelbuild/bazel-gazelle/pull/1784](https://togithub.com/bazelbuild/bazel-gazelle/pull/1784) - Mention JS extension in Aspect CLI by [@​alexeagle](https://togithub.com/alexeagle) in [https://github.com/bazelbuild/bazel-gazelle/pull/1646](https://togithub.com/bazelbuild/bazel-gazelle/pull/1646) - \[Feature] bzlmod & go.work by [@​stefanpenner](https://togithub.com/stefanpenner) in [https://github.com/bazelbuild/bazel-gazelle/pull/1731](https://togithub.com/bazelbuild/bazel-gazelle/pull/1731) - Add GIT_CONFIG_\* env vars to go_repository allow-list by [@​mortenmj](https://togithub.com/mortenmj) in [https://github.com/bazelbuild/bazel-gazelle/pull/1791](https://togithub.com/bazelbuild/bazel-gazelle/pull/1791) - Reformat with latest buildifier by [@​fmeum](https://togithub.com/fmeum) in [https://github.com/bazelbuild/bazel-gazelle/pull/1792](https://togithub.com/bazelbuild/bazel-gazelle/pull/1792) - \[Feature] go.mod FilePath ReplaceDirective Support by [@​stefanpenner](https://togithub.com/stefanpenner) in [https://github.com/bazelbuild/bazel-gazelle/pull/1776](https://togithub.com/bazelbuild/bazel-gazelle/pull/1776) - Fix README.rst by [@​AugustKarlstedt](https://togithub.com/AugustKarlstedt) in [https://github.com/bazelbuild/bazel-gazelle/pull/1795](https://togithub.com/bazelbuild/bazel-gazelle/pull/1795) - Update README.rst by [@​AugustKarlstedt](https://togithub.com/AugustKarlstedt) in [https://github.com/bazelbuild/bazel-gazelle/pull/1796](https://togithub.com/bazelbuild/bazel-gazelle/pull/1796) - Normalise newlines on Windows by [@​illicitonion](https://togithub.com/illicitonion) in [https://github.com/bazelbuild/bazel-gazelle/pull/1798](https://togithub.com/bazelbuild/bazel-gazelle/pull/1798) - Fix go.work use ROOT moddir by [@​hunshcn](https://togithub.com/hunshcn) in [https://github.com/bazelbuild/bazel-gazelle/pull/1800](https://togithub.com/bazelbuild/bazel-gazelle/pull/1800) - allow go_visibility directive to change command package's visibility by [@​hunshcn](https://togithub.com/hunshcn) in [https://github.com/bazelbuild/bazel-gazelle/pull/1794](https://togithub.com/bazelbuild/bazel-gazelle/pull/1794) - Ensure the Gazelle binary is built for the right platform by [@​EdSchouten](https://togithub.com/EdSchouten) in [https://github.com/bazelbuild/bazel-gazelle/pull/1803](https://togithub.com/bazelbuild/bazel-gazelle/pull/1803) - Add support for `debug_mode` option to `go_deps` by [@​davidbyttow](https://togithub.com/davidbyttow) in [https://github.com/bazelbuild/bazel-gazelle/pull/1806](https://togithub.com/bazelbuild/bazel-gazelle/pull/1806) - Remove special resolution of go_proto imports by [@​linzhp](https://togithub.com/linzhp) in [https://github.com/bazelbuild/bazel-gazelle/pull/1807](https://togithub.com/bazelbuild/bazel-gazelle/pull/1807) - address nogo complaints about variable shadowing by [@​pmenglund](https://togithub.com/pmenglund) in [https://github.com/bazelbuild/bazel-gazelle/pull/1808](https://togithub.com/bazelbuild/bazel-gazelle/pull/1808) - Make `# gazelle:proto file` work without needing to set different `option go_package` in .proto files by [@​jeromep-stripe](https://togithub.com/jeromep-stripe) in [https://github.com/bazelbuild/bazel-gazelle/pull/1765](https://togithub.com/bazelbuild/bazel-gazelle/pull/1765) - go_deps: ignore go.work toolchain directive by [@​malt3](https://togithub.com/malt3) in [https://github.com/bazelbuild/bazel-gazelle/pull/1809](https://togithub.com/bazelbuild/bazel-gazelle/pull/1809) - prepare release 0.37.0 by [@​tyler-french](https://togithub.com/tyler-french) in [https://github.com/bazelbuild/bazel-gazelle/pull/1812](https://togithub.com/bazelbuild/bazel-gazelle/pull/1812) #### New Contributors - [@​stefanpenner](https://togithub.com/stefanpenner) made their first contribution in [https://github.com/bazelbuild/bazel-gazelle/pull/1780](https://togithub.com/bazelbuild/bazel-gazelle/pull/1780) - [@​AugustKarlstedt](https://togithub.com/AugustKarlstedt) made their first contribution in [https://github.com/bazelbuild/bazel-gazelle/pull/1795](https://togithub.com/bazelbuild/bazel-gazelle/pull/1795) - [@​hunshcn](https://togithub.com/hunshcn) made their first contribution in [https://github.com/bazelbuild/bazel-gazelle/pull/1800](https://togithub.com/bazelbuild/bazel-gazelle/pull/1800) - [@​EdSchouten](https://togithub.com/EdSchouten) made their first contribution in [https://github.com/bazelbuild/bazel-gazelle/pull/1803](https://togithub.com/bazelbuild/bazel-gazelle/pull/1803) - [@​davidbyttow](https://togithub.com/davidbyttow) made their first contribution in [https://github.com/bazelbuild/bazel-gazelle/pull/1806](https://togithub.com/bazelbuild/bazel-gazelle/pull/1806) - [@​pmenglund](https://togithub.com/pmenglund) made their first contribution in [https://github.com/bazelbuild/bazel-gazelle/pull/1808](https://togithub.com/bazelbuild/bazel-gazelle/pull/1808) - [@​jeromep-stripe](https://togithub.com/jeromep-stripe) made their first contribution in [https://github.com/bazelbuild/bazel-gazelle/pull/1765](https://togithub.com/bazelbuild/bazel-gazelle/pull/1765) **Full Changelog**: bazel-contrib/bazel-gazelle@v0.36.0...v0.37.0 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Enabled. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR was generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View the [repository job log](https://developer.mend.io/github/kreempuff/rules_unreal_engine). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4zNjguMTAiLCJ1cGRhdGVkSW5WZXIiOiIzNy40NDAuNyIsInRhcmdldEJyYW5jaCI6Im1haW4iLCJsYWJlbHMiOltdfQ==-->
](https://renovatebot.com){kind=link}
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.
What type of PR is this?
Feature
What package or component does this PR mostly affect?
language/go
What does this PR do? Why is it needed?
This changes the gazelle's
go_proto_librarygeneration behavior.Previously, in proto file mode, gazelle would generate a separate
go_proto_librarytarget for eachproto_librarytarget, and these would have the same values for the importpath attribute. This caused build errors in certain situations.This change makes Gazelle group
proto_librarytargets which would otherwise have the samego_proto_libraryimportpath, into a singlego_proto_libraryusing theprotosattribute.Which issues(s) does this PR fix?
Fixes #1724
Other notes for review
bazelisk test //...and saw two tests failThis looks like an environment issue. Looks like CI is green though, so I think we can ignore this.
go_proto_librarytarget for multipleproto_librarytargets, the change creates acombinedImportsplatformStringsBuilder variable. I'm not sure if my general approach to combining the dependencies is correct, and would appreciate guidance.