Skip to content

docs(gazelle): Clarify manifest paths in subdirectories - #4397

Merged
aignas merged 2 commits into
bazel-contrib:mainfrom
hartikainen:hartikainen/gazelle-manifest-subdirectories
Nov 2, 2026
Merged

aignas merged 2 commits into
bazel-contrib:mainfrom
hartikainen:hartikainen/gazelle-manifest-subdirectories

Conversation

@hartikainen

@hartikainen hartikainen commented Nov 1, 2026 •

Copy link
Copy Markdown
Contributor

My agent pointed out that #3133 is not actually a bug put just a user error. Gazelle resolves the root manifest paths relative to each BUILD file, so the directives in #3133 example need a ../ prefix.

This documents the path base and relative manifest lookup.

Closes #3133.

Copilot AI balanced review requested due to automatic review settings November 1, 2026 18:26
My agent pointed out that bazel-contrib#3133 is not actually a bug put just a user-error. Gazelle resolves the
root manifest paths relative to each `BUILD` file, so the directives in bazel-contrib#3133 example need a `../`
prefix.

This documents the path base and relative manifest lookup.

Closes bazel-contrib#3133.
@hartikainen
hartikainen force-pushed the hartikainen/gazelle-manifest-subdirectories branch from 9f755f5 to 9264473 Compare November 1, 2026 18:27

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🟡 Changes recommended

The new prose paragraph in gazelle/docs/directives.md needs wrapping at 80 columns to comply with the documented formatting rule.

1 open issue
What changed in this PR

This documentation-only PR clarifies Gazelle’s manifest path configuration, addressing the subdirectory confusion reported in #3133.

Changes:

  • Replaces placeholder documentation for python_manifest_file_name.
  • Documents the default manifest name and relative path base.
  • Adds a ../ example for selecting a repository-root manifest from a subdirectory.
File Description
gazelle/​docs/​directives.md Documents manifest selection and relative paths with a subdirectory example.

Review effort: Balanced

Comment thread gazelle/docs/directives.md Resolved
Updated the description for the `python_manifest_file_name` directive to improve clarity and formatting.

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
@aignas
aignas added this pull request to the merge queue Nov 2, 2026
Merged via the queue into bazel-contrib:main with commit 220231e Nov 2, 2026
13 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

gazelle:python_manifest_file_name not applied in subdirectories

3 participants