Skip to content

Commit fab2f0c

Browse files
committed
chore: update generated docs
1 parent 319b1ae commit fab2f0c

File tree

9 files changed

+37
-21
lines changed

9 files changed

+37
-21
lines changed

buildinfo/bazel_stamp_info.sh

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
#!/bin/bash
2+
# This script is called by Bazel when it needs info about the git state.
3+
# The --workspace_status_command flag tells Bazel the location of this script.
4+
# This is configured in `/.bazelrc`.
5+
set -o pipefail -o errexit -o nounset
6+
7+
function has_local_changes {
8+
if [ "$(git status --porcelain)" != "" ]; then
9+
echo dirty
10+
else
11+
echo clean
12+
fi
13+
}
14+
15+
# "volatile" keys, these will not cause a re-build because they're assumed to change on every build
16+
# and its okay to use a stale value in a stamped binary
17+
echo "BUILD_TIME $(date "+%Y-%m-%d %H:%M:%S %Z")"
18+
19+
# "stable" keys, should remain constant over rebuilds, therefore changed values will cause a
20+
# rebuild of any stamped action that uses ctx.info_file or genrule with stamp = True
21+
# Note, BUILD_USER is automatically available in the stable-status.txt, it matches $USER
22+
echo "STABLE_BUILD_SCM_SHA $(git rev-parse HEAD)"
23+
echo "STABLE_BUILD_SCM_LOCAL_CHANGES $(has_local_changes)"
24+
25+
if [ "$(git tag | wc -l)" -gt 0 ]; then
26+
echo "STABLE_BUILD_SCM_TAG $(git describe --tags)"
27+
fi

docs/aspect.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,5 +30,5 @@ Aspect CLI is a better frontend for running bazel
3030
* [aspect run](aspect_run.md) - Build a single target and run it with the given arguments
3131
* [aspect shutdown](aspect_shutdown.md) - Stop the bazel server
3232
* [aspect test](aspect_test.md) - Build the specified targets and run all test targets among them
33-
* [aspect version](aspect_version.md) - Print the versions of Aspect CLI, Bazelisk, and Bazel
33+
* [aspect version](aspect_version.md) - Print the versions of Aspect CLI and Bazel
3434

docs/aspect_clean.md

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -47,16 +47,7 @@ aspect clean [--expunge] [all] [flags]
4747
### Options
4848

4949
```
50-
--expunge Remove the entire output_base tree.
51-
This removes all build output, external repositories,
52-
and temp files created by Bazel.
53-
It also stops the Bazel server after the clean,
54-
equivalent to the shutdown command.
55-
--expunge_async Expunge in the background.
56-
It is safe to invoke a Bazel command in the same
57-
workspace while the asynchronous expunge continues to run.
58-
Note, however, that this may introduce IO contention.
59-
-h, --help help for clean
50+
-h, --help help for clean
6051
```
6152

6253
### Options inherited from parent commands

docs/aspect_info.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,7 @@ aspect info [keys] [flags]
3131
### Options
3232

3333
```
34-
-h, --help help for info
35-
--show_make_env include the set of key/value pairs in the "Make" environment,
36-
accessible within BUILD files
34+
-h, --help help for info
3735
```
3836

3937
### Options inherited from parent commands

docs/aspect_version.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
## aspect version
22

3-
Print the versions of Aspect CLI, Bazelisk, and Bazel
3+
Print the versions of Aspect CLI and Bazel
44

55
### Synopsis
66

@@ -13,8 +13,7 @@ aspect version [flags]
1313
### Options
1414

1515
```
16-
--gnu_format format space-separated following GNU convention
17-
-h, --help help for version
16+
-h, --help help for version
1817
```
1918

2019
### Options inherited from parent commands

nogo_config.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,8 @@
2727
},
2828
"sigchanyzer": {
2929
"exclude_files": {
30-
"(third_party|vendor|external)/.*": "only run for first-party code"
30+
"(third_party|vendor|external)/.*": "only run for first-party code",
31+
"pkg/bazel/bazelisk.go": "copied third-party code"
3132
}
3233
},
3334
"stdmethods": {

pkg/plugin/sdk/v1alpha1/proto/plugin.pb.go

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

pkg/plugin/sdk/v1alpha2/proto/plugin.pb.go

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

pkg/plugin/sdk/v1alpha3/proto/plugin.pb.go

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)