bazelbuild/bazel

Documentation reference shard_count heuristics

Open

#14,446 opened on Dec 19, 2021

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Java (4,465 forks)batch import
P3help wantedteam-Documentationtype: documentation (cleanup)

Repository metrics

Stars
 (25,384 stars)
PR merge metrics
 (Avg merge 22d 20h) (77 merged PRs in 30d)

Description

The documentation for shard_count says:

This value will override any heuristics used to determine the number of parallel shards with which to run the test. Note that for some test rules, this parameter may be required to enable sharding in the first place. Also see --test_sharding_strategy.

But the docs also say the only permitted values for --test_sharding_strategy are explicit and disabled. In other words, Bazel never shards a test that doesn't specify shard_count.

The reference to heuristics appears to be vestigial (or future?).

Contributor guide

Research direction
Remove the misleading reference to heuristics in the shard count documentation, as Bazel does not automatically shard tests. Also update the test sharding strategy documentation to reflect that it only accepts 'explicit' and 'disabled'.
Tech stack
java
Domain
build system
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90