carverauto/serviceradar

Fork 0

Added Bazel aliases, Alias and Bazel documentation #2306

Merged

marvin-hansen merged 33 commits from refs/pull/2306/head into main

2025-10-12 16:27:42 +00:00

marvin-hansen commented

2025-10-12 06:26:44 +00:00

(Migrated from github.com)

Owner

Imported from GitHub pull request.

Original GitHub pull request: #1745
Original author: @marvin-hansen
Original URL: https://github.com/carverauto/serviceradar/pull/1745
Original created: 2025-10-12T06:26:44Z
Original updated: 2025-10-12T16:27:42Z
Original head: main
Original base: main
Original merged: 2025-10-12T16:27:42Z by @mfreeman451

User description

This PR add:

Bazel target aliases to new root level folder alias
Updated all Go targets in cmd to use aliases to libs
Added a README to alias to explain why aliases are used
Added Bazel.md with basic documentation about Bazel
Updated RELEASE.md to tick of another checkbox for CNCF

Recommend squash merge as somehow this PR piggy backs all commits from the last PR
and these can all be squashed into one.

PR Type

Enhancement, Documentation

Description

Added Bazel aliases for all packages in alias/ folder
Updated all cmd/ targets to use aliases instead of direct paths
Added comprehensive Bazel documentation with usage examples
Updated release documentation with detailed publishing workflow

Diagram Walkthrough

flowchart LR
  A["Direct pkg/ dependencies"] --> B["Alias system"]
  B --> C["Simplified dependency management"]
  D["Basic docs"] --> E["Comprehensive Bazel.md"]
  F["Simple RELEASE.md"] --> G["Detailed release workflow"]

File Walkthrough

Relevant files

Documentation

3 files

Bazel.md `Added comprehensive Bazel usage documentation`	+88/-0
RELEASE.md `Expanded release documentation with detailed workflow`	+113/-6
README.md `Added alias system documentation and rationale`	+47/-0

Enhancement

13 files

BUILD.bazel `Created Bazel aliases for all packages`	+226/-0
BUILD.bazel `Updated dependencies to use aliases`	+5/-5
BUILD.bazel `Updated dependencies to use aliases`	+3/-3
BUILD.bazel `Updated dependencies to use aliases`	+4/-4
BUILD.bazel `Updated dependencies to use aliases`	+4/-4
BUILD.bazel `Updated dependencies to use aliases`	+1/-1
BUILD.bazel `Updated dependencies to use aliases`	+6/-6
BUILD.bazel `Updated dependencies to use aliases`	+6/-6
BUILD.bazel `Updated dependencies to use aliases`	+5/-5
BUILD.bazel `Updated dependencies to use aliases`	+3/-3
BUILD.bazel `Updated dependencies to use aliases`	+3/-3
BUILD.bazel `Updated dependencies to use aliases`	+5/-5
BUILD.bazel `Updated dependencies to use aliases`	+4/-4

Bug fix

1 files

BUILD.bazel
Fixed source file name reference +2/-2

Additional files

2 files

BUILD.bazel	[link]
host_freq.mm	[link]

Imported from GitHub pull request. Original GitHub pull request: #1745 Original author: @marvin-hansen Original URL: https://github.com/carverauto/serviceradar/pull/1745 Original created: 2025-10-12T06:26:44Z Original updated: 2025-10-12T16:27:42Z Original head: main Original base: main Original merged: 2025-10-12T16:27:42Z by @mfreeman451 --- ### **User description** This PR add: * Bazel target aliases to new root level folder alias * Updated all Go targets in cmd to use aliases to libs * Added a README to alias to explain why aliases are used * Added Bazel.md with basic documentation about Bazel * Updated RELEASE.md to tick of another checkbox for CNCF Recommend squash merge as somehow this PR piggy backs all commits from the last PR and these can all be squashed into one. ___ ### **PR Type** Enhancement, Documentation ___ ### **Description** - Added Bazel aliases for all packages in `alias/` folder - Updated all `cmd/` targets to use aliases instead of direct paths - Added comprehensive Bazel documentation with usage examples - Updated release documentation with detailed publishing workflow ___ ### Diagram Walkthrough ```mermaid flowchart LR A["Direct pkg/ dependencies"] --> B["Alias system"] B --> C["Simplified dependency management"] D["Basic docs"] --> E["Comprehensive Bazel.md"] F["Simple RELEASE.md"] --> G["Detailed release workflow"] ``` <details> <summary><h3> File Walkthrough</h3></summary> <table><thead><tr><th></th><th align="left">Relevant files</th></tr></thead><tbody><tr><td><strong>Documentation</strong></td><td><details><summary>3 files</summary><table> <tr> <td><strong>Bazel.md</strong><dd><code>Added comprehensive Bazel usage documentation</code>                        </dd></td> <td><a href="https://github.com/carverauto/serviceradar/pull/1745/files#diff-6be72dda32c0a6480648cd95071f2266ed166694052974f8137c7f7f650599d0">+88/-0</a>    </td> </tr> <tr> <td><strong>RELEASE.md</strong><dd><code>Expanded release documentation with detailed workflow</code>        </dd></td> <td><a href="https://github.com/carverauto/serviceradar/pull/1745/files#diff-2b1b69303b927a484e02c7fad9fc87d0d3ff0dc22ae1da0ecd0dc935d922a23c">+113/-6</a>  </td> </tr> <tr> <td><strong>README.md</strong><dd><code>Added alias system documentation and rationale</code>                      </dd></td> <td><a href="https://github.com/carverauto/serviceradar/pull/1745/files#diff-484fd90d15537312547e4f244a6e8bcd9722ddf587664b37fede641e27c2e767">+47/-0</a>    </td> </tr> </table></details></td></tr><tr><td><strong>Enhancement</strong></td><td><details><summary>13 files</summary><table> <tr> <td><strong>BUILD.bazel</strong><dd><code>Created Bazel aliases for all packages</code>                                      </dd></td> <td><a href="https://github.com/carverauto/serviceradar/pull/1745/files#diff-884fa9353a5226345e44fbabea3300efc7a87dfbcde0b6a42521ca51823f1b68">+226/-0</a>  </td> </tr> <tr> <td><strong>BUILD.bazel</strong><dd><code>Updated dependencies to use aliases</code>                                            </dd></td> <td><a href="https://github.com/carverauto/serviceradar/pull/1745/files#diff-143f8d1549d52f28906f19ce28e5568a5be474470ff103c2c1e63c3e6b08d670">+5/-5</a>      </td> </tr> <tr> <td><strong>BUILD.bazel</strong><dd><code>Updated dependencies to use aliases</code>                                            </dd></td> <td><a href="https://github.com/carverauto/serviceradar/pull/1745/files#diff-c5a714dfa29850bd891ea70c308bf459a16cf6623c9c20b14efce653b5a2890c">+3/-3</a>      </td> </tr> <tr> <td><strong>BUILD.bazel</strong><dd><code>Updated dependencies to use aliases</code>                                            </dd></td> <td><a href="https://github.com/carverauto/serviceradar/pull/1745/files#diff-a4677c1b820d80470df120cbb56dd6d8a185de34399ac6f3431bf116845bbb29">+4/-4</a>      </td> </tr> <tr> <td><strong>BUILD.bazel</strong><dd><code>Updated dependencies to use aliases</code>                                            </dd></td> <td><a href="https://github.com/carverauto/serviceradar/pull/1745/files#diff-6f29400e46ef3dfa4e1d5e3ec41ebfeceb9628f6900f815f5c9bc8166ccc63a9">+4/-4</a>      </td> </tr> <tr> <td><strong>BUILD.bazel</strong><dd><code>Updated dependencies to use aliases</code>                                            </dd></td> <td><a href="https://github.com/carverauto/serviceradar/pull/1745/files#diff-28585d443ee238a985024d78e491e8a2f060b26fd076b99325bd5fb672354062">+1/-1</a>      </td> </tr> <tr> <td><strong>BUILD.bazel</strong><dd><code>Updated dependencies to use aliases</code>                                            </dd></td> <td><a href="https://github.com/carverauto/serviceradar/pull/1745/files#diff-ba4bbabb721d98056e2dc9a701e251b851b58e572cb720010b7c8fe7c66b4f74">+6/-6</a>      </td> </tr> <tr> <td><strong>BUILD.bazel</strong><dd><code>Updated dependencies to use aliases</code>                                            </dd></td> <td><a href="https://github.com/carverauto/serviceradar/pull/1745/files#diff-fe50aa09443ec66049932b1528481cf6ab3c09f65f10d8c1c26af0d8d22545f5">+6/-6</a>      </td> </tr> <tr> <td><strong>BUILD.bazel</strong><dd><code>Updated dependencies to use aliases</code>                                            </dd></td> <td><a href="https://github.com/carverauto/serviceradar/pull/1745/files#diff-cf437f055db002c5a1dba0ac4a4949d0ecc4b095e8e760bf5aec0f5d4c08f572">+5/-5</a>      </td> </tr> <tr> <td><strong>BUILD.bazel</strong><dd><code>Updated dependencies to use aliases</code>                                            </dd></td> <td><a href="https://github.com/carverauto/serviceradar/pull/1745/files#diff-fc40668be588ec6d0281ab2f50dcfc5d137d4939b7ee9f6af19a2c9f90bfc98a">+3/-3</a>      </td> </tr> <tr> <td><strong>BUILD.bazel</strong><dd><code>Updated dependencies to use aliases</code>                                            </dd></td> <td><a href="https://github.com/carverauto/serviceradar/pull/1745/files#diff-46036d7e2c4847b255a72412892db1c023dfb4c5fe428a05f4d335a284074726">+3/-3</a>      </td> </tr> <tr> <td><strong>BUILD.bazel</strong><dd><code>Updated dependencies to use aliases</code>                                            </dd></td> <td><a href="https://github.com/carverauto/serviceradar/pull/1745/files#diff-e1f7c698e0e3a4e6afa971c1140e71cbf22593fbb19c81cb26b02c15c5dc46ec">+5/-5</a>      </td> </tr> <tr> <td><strong>BUILD.bazel</strong><dd><code>Updated dependencies to use aliases</code>                                            </dd></td> <td><a href="https://github.com/carverauto/serviceradar/pull/1745/files#diff-4f5d2ea4260d490a0d6f28adde0b35eca8af77d22f3ee366a783946c53687619">+4/-4</a>      </td> </tr> </table></details></td></tr><tr><td><strong>Bug fix</strong></td><td><details><summary>1 files</summary><table> <tr> <td><strong>BUILD.bazel</strong><dd><code>Fixed source file name reference</code>                                                  </dd></td> <td><a href="https://github.com/carverauto/serviceradar/pull/1745/files#diff-184fb3e268873ce89047d398ddf2b684f39118babe9b0ca9c5075416aabdd506">+2/-2</a>      </td> </tr> </table></details></td></tr><tr><td><strong>Additional files</strong></td><td><details><summary>2 files</summary><table> <tr> <td><strong>BUILD.bazel</strong></td> <td><a href="https://github.com/carverauto/serviceradar/pull/1745/files#diff-13652ffce40d2e7430a19e82ae9041f74594be2464a466b2d69b62a783a356f9">[link]</a>    </td> </tr> <tr> <td><strong>host_freq.mm</strong></td> <td><a href="https://github.com/carverauto/serviceradar/pull/1745/files#diff-9e5562d3d7396efb04069b668e447d639f758d2e7d06672cf1ea645b039e733c">[link]</a>    </td> </tr> </table></details></td></tr></tr></tbody></table> </details> ___

qodo-code-review[bot] commented

2025-10-12 06:27:20 +00:00

(Migrated from github.com)

Author

Owner

Imported GitHub PR comment.

Original author: @qodo-code-review[bot]
Original URL: https://github.com/carverauto/serviceradar/pull/1745#issuecomment-3393982121
Original created: 2025-10-12T06:27:20Z

PR Compliance Guide 🔍

Below is a summary of compliance checks for this PR:

Security Compliance
🟢	No security concerns identified No security vulnerabilities detected by AI analysis. Human verification advised for critical code.
Ticket Compliance
⚪	🎫 No ticket provided Create ticket/issue
Codebase Duplication Compliance
⚪	Codebase context is not defined Follow the guide to enable codebase context checks.
Custom Compliance
⚪	No custom compliance provided Follow the guide to enable custom compliance check.

Compliance status legend

🟢 - Fully Compliant
🟡 - Partial Compliant
🔴 - Not Compliant
⚪ - Requires Further Human Verification
🏷️ - Compliance label

Imported GitHub PR comment. Original author: @qodo-code-review[bot] Original URL: https://github.com/carverauto/serviceradar/pull/1745#issuecomment-3393982121 Original created: 2025-10-12T06:27:20Z --- ## PR Compliance Guide 🔍  Below is a summary of compliance checks for this PR:<br> <table><tbody><tr><td colspan='2'><strong>Security Compliance</strong></td></tr> <tr><td>🟢</td><td><details><summary><strong>No security concerns identified</strong></summary> No security vulnerabilities detected by AI analysis. Human verification advised for critical code. </details></td></tr> <tr><td colspan='2'><strong>Ticket Compliance</strong></td></tr> <tr><td>⚪</td><td><details><summary>🎫 <strong>No ticket provided </summary></strong> - [ ] Create ticket/issue  </details></td></tr> <tr><td colspan='2'><strong>Codebase Duplication Compliance</strong></td></tr> <tr><td>⚪</td><td><details><summary><strong>Codebase context is not defined </strong></summary> Follow the <a href='https://qodo-merge-docs.qodo.ai/core-abilities/rag_context_enrichment/'>guide</a> to enable codebase context checks. </details></td></tr> <tr><td colspan='2'><strong>Custom Compliance</strong></td></tr> <tr><td>⚪</td><td><details><summary><strong>No custom compliance provided</strong></summary> Follow the <a href='https://qodo-merge-docs.qodo.ai/tools/compliance/'>guide</a> to enable custom compliance check. </details></td></tr> <tr><td align="center" colspan="2">   </td></tr></tbody></table> <details><summary>Compliance status legend</summary> 🟢 - Fully Compliant<br> 🟡 - Partial Compliant<br> 🔴 - Not Compliant<br> ⚪ - Requires Further Human Verification<br> 🏷️ - Compliance label<br> </details>

qodo-code-review[bot] commented

2025-10-12 06:28:12 +00:00

(Migrated from github.com)

Author

Owner

Imported GitHub PR comment.

Original author: @qodo-code-review[bot]
Original URL: https://github.com/carverauto/serviceradar/pull/1745#issuecomment-3393982530
Original created: 2025-10-12T06:28:12Z

PR Code Suggestions ✨

Explore these optional code suggestions:

Category	Suggestion	Impact
High-level	Adopt namespaced aliases for scalability The current implementation of Bazel aliases uses a single flat namespace, which contradicts the new documentation's recommendation for a more scalable, namespaced structure using subdirectories. It is suggested to refactor the aliases into subdirectories like `alias/core/` and `alias/checkers/` to prevent future name collisions and improve organization. Examples: alias/BUILD.bazel [1-226] `package(default_visibility = ["//visibility:public"]) # pkg/agent alias( name = "agent", actual = "//pkg/agent:agent", ) # pkg/checker alias( ... (clipped 216 lines)` alias/README.md [23-43] `In practice, it is often sensible to segment the alias namespace wit a few folders, for example:` alias/ service/ client/ test_tools/ `Which then translates to dependency paths like: ... (clipped 11 lines)` Solution Walkthrough: Before: `# File: alias/BUILD.bazel alias( name = "agent", actual = "//pkg/agent:agent", ) alias( name = "dusk", actual = "//pkg/checker/dusk:dusk", ) # ... many more aliases in a flat list # File: cmd/agent/BUILD.bazel go_library( ... deps = ["//alias:agent", ...], )` After: `# File structure: # alias/ # ├── BUILD.bazel (for common aliases) # ├── core/BUILD.bazel # └── checkers/BUILD.bazel # File: alias/checkers/BUILD.bazel alias( name = "dusk", actual = "//pkg/checker/dusk:dusk", ) # File: cmd/checkers/dusk/BUILD.bazel go_library( ... deps = ["//alias/checkers:dusk", ...], )` Suggestion importance[1-10]: 9 __ Why: The suggestion correctly identifies a major inconsistency where the implemented flat alias structure in `alias/BUILD.bazel` contradicts the namespaced approach recommended in the new `alias/README.md`, which impacts the scalability and maintainability of the new dependency system.	High
More

Imported GitHub PR comment. Original author: @qodo-code-review[bot] Original URL: https://github.com/carverauto/serviceradar/pull/1745#issuecomment-3393982530 Original created: 2025-10-12T06:28:12Z --- ## PR Code Suggestions ✨  Explore these optional code suggestions: <table><thead><tr><td><strong>Category</strong></td><td align=left><strong>Suggestion                                                                                                                                    </strong></td><td align=center><strong>Impact</strong></td></tr><tbody><tr><td rowspan=1>High-level</td> <td> <details><summary>Adopt namespaced aliases for scalability</summary> ___ **The current implementation of Bazel aliases uses a single flat namespace, which <br>contradicts the new documentation's recommendation for a more scalable, <br>namespaced structure using subdirectories. It is suggested to refactor the <br>aliases into subdirectories like <code>alias/core/</code> and <code>alias/checkers/</code> to prevent <br>future name collisions and improve organization.** ### Examples: <details> <summary> <a href="https://github.com/carverauto/serviceradar/pull/1745/files#diff-884fa9353a5226345e44fbabea3300efc7a87dfbcde0b6a42521ca51823f1b68R1-R226">alias/BUILD.bazel [1-226]</a> </summary> ```starlark package(default_visibility = ["//visibility:public"]) # pkg/agent alias( name = "agent", actual = "//pkg/agent:agent", ) # pkg/checker alias( ... (clipped 216 lines) ``` </details> <details> <summary> <a href="https://github.com/carverauto/serviceradar/pull/1745/files#diff-484fd90d15537312547e4f244a6e8bcd9722ddf587664b37fede641e27c2e767R23-R43">alias/README.md [23-43]</a> </summary> ```markdown In practice, it is often sensible to segment the alias namespace wit a few folders, for example: ``` alias/ service/ client/ test_tools/ ``` Which then translates to dependency paths like: ... (clipped 11 lines) ``` </details> ### Solution Walkthrough: #### Before: ```markdown # File: alias/BUILD.bazel alias( name = "agent", actual = "//pkg/agent:agent", ) alias( name = "dusk", actual = "//pkg/checker/dusk:dusk", ) # ... many more aliases in a flat list # File: cmd/agent/BUILD.bazel go_library( ... deps = ["//alias:agent", ...], ) ``` #### After: ```markdown # File structure: # alias/ # ├── BUILD.bazel (for common aliases) # ├── core/BUILD.bazel # └── checkers/BUILD.bazel # File: alias/checkers/BUILD.bazel alias( name = "dusk", actual = "//pkg/checker/dusk:dusk", ) # File: cmd/checkers/dusk/BUILD.bazel go_library( ... deps = ["//alias/checkers:dusk", ...], ) ``` <details><summary>Suggestion importance[1-10]: 9</summary> __ Why: The suggestion correctly identifies a major inconsistency where the implemented flat alias structure in `alias/BUILD.bazel` contradicts the namespaced approach recommended in the new `alias/README.md`, which impacts the scalability and maintainability of the new dependency system. </details></details></td><td align=center>High </td></tr> <tr><td align="center" colspan="2"> - [ ] More  </td><td></td></tr></tbody></table>

marvin-hansen commented

2025-10-12 07:13:05 +00:00

(Migrated from github.com)

Author

Owner

Imported GitHub PR comment.

Original author: @marvin-hansen
Original URL: https://github.com/carverauto/serviceradar/pull/1745#issuecomment-3394009859
Original created: 2025-10-12T07:13:05Z

CI tests pass, but there is still the same permission denied error as last time. In other words, the PR can be merged.
Probably a good idea to ask in the BB slack here this error is coming from as its not so clear to me what is causing it.

[1A^[[K(01:49:50) ^[[31m^[[1mERROR: ^[[0mThe Build Event Protocol upload failed: Not retrying publishBuildEvents, no more attempts left: status='Status{code=PERMISSION_DENIED, description=Anonymous access disabled, permission denied., cause=null}' PERMISSION_DENIED: PERMISSION_DENIED: Anonymous access disabled, permission denied. PERMISSION_DENIED: PERMISSION_DENIED: Anonymous access disabled, permission denied.

Imported GitHub PR comment. Original author: @marvin-hansen Original URL: https://github.com/carverauto/serviceradar/pull/1745#issuecomment-3394009859 Original created: 2025-10-12T07:13:05Z --- CI tests pass, but there is still the same permission denied error as last time. In other words, the PR can be merged. Probably a good idea to ask in the BB slack here this error is coming from as its not so clear to me what is causing it. [1A^[[K(01:49:50) ^[[31m^[[1mERROR: ^[[0mThe Build Event Protocol upload failed: Not retrying publishBuildEvents, no more attempts left: status='Status{code=PERMISSION_DENIED, description=Anonymous access disabled, permission denied., cause=null}' PERMISSION_DENIED: PERMISSION_DENIED: Anonymous access disabled, permission denied. PERMISSION_DENIED: PERMISSION_DENIED: Anonymous access disabled, permission denied.