bazelbuild / bazelbuild/bazelisk

Document format of .bazelversion file

Open
#408 1 comment 5 reactions 0 assignees View on GitHub
P2 type: documentation
Dominant language
Go
Stars
2.7k
Forks
424
PR merge metrics
No merged PRs in 30d

Description

Is there any documentation on the syntax supported in `.bazelversion` files?

Is it legal to use comments?
```
# Bazel 6 causes regression, fix to 5.x for now.
5.4.0
```

Can we specify sets of versions somehow, e.g. like this:
```
5.x.x
```
or
```
5
```

Would be great to have this be documented.

Contributor guide

Open the contributing guide

Research direction

Start by locating the `.bazelversion` parser and any existing user documentation for Bazelisk. Document the supported syntax, including whether comments and version patterns such as `5.x.x` or `5` are accepted, and ensure the examples answer the questions raised in this issue.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.