Skip to content
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.

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

Bazel 'test' options not clearly findable #5290

Open
EricBurnett opened this issue May 29, 2018 · 2 comments
Open

Bazel 'test' options not clearly findable #5290

EricBurnett opened this issue May 29, 2018 · 2 comments
Assignees
Labels
P3 We're not considering working on this, but happy to review a PR. (No assignee) team-Documentation Documentation improvements that cannot be directly linked to other team labels team-OSS Issues for the Bazel OSS team: installation, release processBazel packaging, website type: documentation (cleanup)

Comments

@EricBurnett
Copy link

Description of the problem / feature request:

Bazel 'test' behaviour and options are not clearly documented. Specifically, the fact that bazel test builds all non-test targets by default is only documented under a 'miscellaneous' flag.

Feature requests: what underlying problem are you trying to solve with this feature?

  1. Categorize 'Miscellaneous options' so that they show up in appropriate sections. Namely, https://docs.bazel.build/versions/master/command-line-reference.html#test should include --[no]build_tests_only , --flaky_test_attempts, and other such test-specific flags. Most of the rest should be categorized as well.

  2. A page about tests might also be appropriate. https://docs.bazel.build/versions/master/test-encyclopedia.html has the technical specifications, but I cannot find a page that clearly documents the basics - when you'll run bazel test and what it does. Nothing linked off of https://docs.bazel.build/versions/master/getting-started.html appears to talk about testing.

Bugs: what's the simplest, easiest way to reproduce this bug? Please provide a minimal example if possible.

N/A

What operating system are you running Bazel on?

N/A

What's the output of bazel info release?

N/A

Have you found anything relevant by searching the web?

Searching the web finds misleading answers, e.g. a cursory read of #4257 (first link from "bazel build all targets") implies that "bazel test //... && bazel build //..." is a reasonable pattern, when it's actually an antipattern.

This would presumably be mitigated if there were clear answers in bazel documentation proper.

@jin jin added team-Bazel General Bazel product/strategy issues untriaged and removed category: misc > testing labels Jan 16, 2019
@dslomov dslomov added team-Local-Exec Issues and PRs for the Execution (Local) team and removed team-Bazel General Bazel product/strategy issues labels Jul 23, 2019
@jmmv jmmv added team-OSS Issues for the Bazel OSS team: installation, release processBazel packaging, website and removed team-Local-Exec Issues and PRs for the Execution (Local) team labels Sep 11, 2019
@jmmv
Copy link
Contributor

jmmv commented Sep 11, 2019

I don't think this belongs to "local execution" and is more of an issue documenting general command line behavior. Moving to the Xproduct team, which apparently covers this topic.

@philwo philwo added the P3 We're not considering working on this, but happy to review a PR. (No assignee) label Dec 8, 2020
@philwo philwo removed the untriaged label Feb 8, 2021
@sgowroji sgowroji added the team-Documentation Documentation improvements that cannot be directly linked to other team labels label Jan 11, 2023
Copy link

Thank you for contributing to the Bazel repository! This issue has been marked as stale since it has not had any activity in the last 1+ years. It will be closed in the next 90 days unless any other activity occurs. If you think this issue is still relevant and should stay open, please post any comment here and the issue will no longer be marked as stale.

@github-actions github-actions bot added the stale Issues or PRs that are stale (no activity for 30 days) label Mar 17, 2024
@meisterT meisterT self-assigned this Jun 13, 2024
@github-actions github-actions bot removed the stale Issues or PRs that are stale (no activity for 30 days) label Jun 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
P3 We're not considering working on this, but happy to review a PR. (No assignee) team-Documentation Documentation improvements that cannot be directly linked to other team labels team-OSS Issues for the Bazel OSS team: installation, release processBazel packaging, website type: documentation (cleanup)
Projects
None yet
Development

No branches or pull requests

8 participants