-
Notifications
You must be signed in to change notification settings - Fork 45
/
update-stardoc-docs.sh
executable file
·31 lines (25 loc) · 1.13 KB
/
update-stardoc-docs.sh
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
#!/usr/bin/env bash
# Copyright 2019 The Bazel Authors. All rights reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# Renerates the Stardoc rule documentation from source.
set -eu
# Allow users to override the bazel command with e.g. bazelisk.
: "${USE_BAZEL_VERSION:=8.0.0-pre.20240603.2}"
: "${BAZEL:=bazelisk}"
echo "** Generating Stardoc documentation..."
USE_BAZEL_VERSION="${USE_BAZEL_VERSION}" ${BAZEL} build //stardoc:stardoc_doc.md
echo "** Copying result to docs/stardoc_rule.md ..."
cp bazel-bin/stardoc/stardoc_doc.md docs/stardoc_rule.md
echo "** Done! Please manually verify the new documentation looks good before committing."