bazelbuild/bazel

Documentation for .bazelversion

Open

#11,264 opened on Apr 30, 2020

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

Repository metrics

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

Description

I think we need some documentation to explain what is the .bazelversion file and how/when it should be used.

I wonder if there's a way to make the check a bit less strict. For example, I couldn't use my Bazel 3.1.0 for a project that declares Bazel 3.0.0. Is there a syntax like 3.x.x (or just 3) to allow this?

Also, the error message said The project you're trying to build requires Bazel 3.0.0, but it didn't which version of Bazel I was using. And bazel help and bazel version were not working because of the version check.

Contributor guide

Research direction
Explore the existing documentation files related to .bazelversion and examine the version check implementation in the codebase to understand the current logic and suggest improvements.
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.
1-3 hours
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
GitBazel
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85