• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1## versions.get
2
3<pre>
4versions.get()
5</pre>
6
7Returns the current Bazel version
8
9
10
11## versions.parse
12
13<pre>
14versions.parse(<a href="#versions.parse-bazel_version">bazel_version</a>)
15</pre>
16
17Parses a version string into a 3-tuple of ints
18
19int tuples can be compared directly using binary operators (<, >).
20
21
22### Parameters
23
24<table class="params-table">
25  <colgroup>
26    <col class="col-param" />
27    <col class="col-description" />
28  </colgroup>
29  <tbody>
30    <tr id="versions.parse-bazel_version">
31      <td><code>bazel_version</code></td>
32      <td>
33        required.
34        <p>
35          the Bazel version string
36        </p>
37      </td>
38    </tr>
39  </tbody>
40</table>
41
42
43## versions.check
44
45<pre>
46versions.check(<a href="#versions.check-minimum_bazel_version">minimum_bazel_version</a>, <a href="#versions.check-maximum_bazel_version">maximum_bazel_version</a>, <a href="#versions.check-bazel_version">bazel_version</a>)
47</pre>
48
49Check that the version of Bazel is valid within the specified range.
50
51### Parameters
52
53<table class="params-table">
54  <colgroup>
55    <col class="col-param" />
56    <col class="col-description" />
57  </colgroup>
58  <tbody>
59    <tr id="versions.check-minimum_bazel_version">
60      <td><code>minimum_bazel_version</code></td>
61      <td>
62        required.
63        <p>
64          minimum version of Bazel expected
65        </p>
66      </td>
67    </tr>
68    <tr id="versions.check-maximum_bazel_version">
69      <td><code>maximum_bazel_version</code></td>
70      <td>
71        optional. default is <code>None</code>
72        <p>
73          maximum version of Bazel expected
74        </p>
75      </td>
76    </tr>
77    <tr id="versions.check-bazel_version">
78      <td><code>bazel_version</code></td>
79      <td>
80        optional. default is <code>None</code>
81        <p>
82          the version of Bazel to check. Used for testing, defaults to native.bazel_version
83        </p>
84      </td>
85    </tr>
86  </tbody>
87</table>
88
89
90## versions.is_at_most
91
92<pre>
93versions.is_at_most(<a href="#versions.is_at_most-threshold">threshold</a>, <a href="#versions.is_at_most-version">version</a>)
94</pre>
95
96Check that a version is lower or equals to a threshold.
97
98### Parameters
99
100<table class="params-table">
101  <colgroup>
102    <col class="col-param" />
103    <col class="col-description" />
104  </colgroup>
105  <tbody>
106    <tr id="versions.is_at_most-threshold">
107      <td><code>threshold</code></td>
108      <td>
109        required.
110        <p>
111          the maximum version string
112        </p>
113      </td>
114    </tr>
115    <tr id="versions.is_at_most-version">
116      <td><code>version</code></td>
117      <td>
118        required.
119        <p>
120          the version string to be compared to the threshold
121        </p>
122      </td>
123    </tr>
124  </tbody>
125</table>
126
127
128## versions.is_at_least
129
130<pre>
131versions.is_at_least(<a href="#versions.is_at_least-threshold">threshold</a>, <a href="#versions.is_at_least-version">version</a>)
132</pre>
133
134Check that a version is higher or equals to a threshold.
135
136### Parameters
137
138<table class="params-table">
139  <colgroup>
140    <col class="col-param" />
141    <col class="col-description" />
142  </colgroup>
143  <tbody>
144    <tr id="versions.is_at_least-threshold">
145      <td><code>threshold</code></td>
146      <td>
147        required.
148        <p>
149          the minimum version string
150        </p>
151      </td>
152    </tr>
153    <tr id="versions.is_at_least-version">
154      <td><code>version</code></td>
155      <td>
156        required.
157        <p>
158          the version string to be compared to the threshold
159        </p>
160      </td>
161    </tr>
162  </tbody>
163</table>
164
165
166