Skip to content

WIP Tango configuration documentation#180

Draft
yushan8 wants to merge 12 commits into
mainfrom
yushan/add-config-doc
Draft

WIP Tango configuration documentation#180
yushan8 wants to merge 12 commits into
mainfrom
yushan/add-config-doc

Conversation

@yushan8

@yushan8 yushan8 commented Jul 10, 2026

Copy link
Copy Markdown
Contributor

Documents all user-facing configuration fields across service, repository, and storage sections.

@yushan8 yushan8 changed the title docs(config): add configuration reference docs(config): RFC add configuration reference Jul 10, 2026
@yushan8 yushan8 changed the title docs(config): RFC add configuration reference docs(config): Tango configuration RFC Jul 10, 2026
@yushan8 yushan8 marked this pull request as ready for review July 10, 2026 22:33
@yushan8 yushan8 requested review from a team as code owners July 10, 2026 22:33
@yushan8 yushan8 marked this pull request as draft July 10, 2026 22:33
@yushan8 yushan8 marked this pull request as ready for review July 10, 2026 22:54
Comment thread docs/config/config.md Outdated
| Field | Required | Type | Default | Description |
|---|---|---|---|---|
| `remote` | **Yes** | `string` | | The URL used to `git clone` the repository. Must be unique across all entries. Must match exactly what clients send in `BuildDescription.remote`. |
| `bzlmod_enabled` | No | `bool` | `false` | Use Bzlmod for external dependency management. When disabled, `//external:all-targets` is added to Bazel queries for WORKSPACE-based repositories. |

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

BzlMod is enforced in Bazel 9 and above. Why is the default false and not true given in a year that this is the standard.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Good point - updated.

Comment thread docs/config/config.md Outdated
| `bazel_extra_args` | No | `[]string` | `[]` | Extra arguments passed to every Bazel invocation. |
| `query_timeout_seconds` | No | `int64` | `600` | Bazel query timeout in seconds. |
| `hash_external_repo_files` | No | `[]string` | `[]` | External repositories to hash per-file instead of using the default repo-level hash. By default, all files in an external repo share a single hash, so a version bump marks every target as changed. Listing a repo here hashes each file individually for finer change detection at the cost of slower computation. |
| `excluded_files` | No | `[]string` | `[]` | Regex patterns for files to exclude from analysis (e.g. `"^@@?bazel_tools/"`). |

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

What is "analysis" in this case? Should we be more descriptive here?

Comment thread docs/config/config.md Outdated
Comment thread docs/config/config.md Outdated
Comment thread docs/config/config.md Outdated

| Field | Required | Type | Default | Description |
|---|---|---|---|---|
| `max_worker_pool_size` | **Yes** | `int` | | Number of concurrent worker workspaces per repository. Must be greater than 0. |

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Doesn't this control the number of concurrent request that can be handled? Reading the current description, I am not sure what value I should be putting here

@yushan8 yushan8 marked this pull request as draft July 10, 2026 23:33
@yushan8 yushan8 changed the title docs(config): Tango configuration RFC WIP Tango configuration documentation Jul 11, 2026
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.

2 participants