Skip to content

docs: Fix broken links to bzlmod build_file_generation example #3464

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
aignas merged 1 commit into from
Dec 15, 2025
Merged

docs: Fix broken links to bzlmod build_file_generation example #3464

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion .bazelignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@ examples/bzlmod/other_module/bazel-other_module
examples/bzlmod/other_module/bazel-out
examples/bzlmod/other_module/bazel-testlogs
examples/bzlmod/py_proto_library/foo_external
examples/bzlmod_build_file_generation/bazel-bzlmod_build_file_generation
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist bot Dec 15, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

You've removed the ignore entry for the old path, but it seems the entry for the new path is missing. To prevent Bazel-generated files from being accidentally committed, you should probably add an entry for the new location of the example's build artifacts: gazelle/examples/bzlmod_build_file_generation/bazel-bzlmod_build_file_generation.

Copy link
Copy Markdown
Contributor Author

@willstranton willstranton Dec 15, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

...it seems the entry for the new path is missing...

See line 29.

examples/multi_python_versions/bazel-multi_python_versions
examples/pip_parse/bazel-pip_parse
examples/pip_parse_vendored/bazel-pip_parse_vendored
Expand Down
2 changes: 1 addition & 1 deletion BZLMOD_SUPPORT.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ We have two examples that demonstrate how to configure `bzlmod`.
The first example is in [examples/bzlmod](examples/bzlmod), and it demonstrates basic bzlmod configuration.
A user does not use `local_path_override` stanza and would define the version in the `bazel_dep` line.

A second example, in [examples/bzlmod_build_file_generation](examples/bzlmod_build_file_generation) demonstrates the use of `bzlmod` to configure `gazelle` support for `rules_python`.
A second example, in [gazelle/examples/bzlmod_build_file_generation](gazelle/examples/bzlmod_build_file_generation) demonstrates the use of `bzlmod` to configure `gazelle` support for `rules_python`.

## Differences in behavior from WORKSPACE

Expand Down
2 changes: 1 addition & 1 deletion examples/build_file_generation/.bazelrc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ test --test_output=errors --enable_runfiles
# Windows requires these for multi-python support:
build --enable_runfiles

# The bzlmod version of this example is in examples/bzlmod_build_file_generation
# The bzlmod version of this example is in gazelle/examples/bzlmod_build_file_generation
# Once WORKSPACE support is dropped, this example can be entirely deleted.
common --noenable_bzlmod
common --enable_workspace
Expand Down
2 changes: 1 addition & 1 deletion gazelle/docs/installation_and_usage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
Examples of using Gazelle with Python can be found in the `rules_python`
repo:

* bzlmod: {gh-path}`examples/bzlmod_build_file_generation`
* bzlmod: {gh-path}`gazelle/examples/bzlmod_build_file_generation`
* WORKSPACE: {gh-path}`examples/build_file_generation`

:::{note}
Expand Down