Skip to content

Commit e7fd6e6

Browse files
Update README.md
1 parent 8e6916d commit e7fd6e6

File tree

1 file changed

+41
-32
lines changed

1 file changed

+41
-32
lines changed

README.md

Lines changed: 41 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -71,65 +71,74 @@ Open `bazel-diff-example.sh` to see how this is implemented. This is purely an e
7171
`bazel-diff` Command
7272

7373
```terminal
74-
Usage: bazel-diff [-hV] -b=<bazelPath> [-co=<bazelCommandOptions>]
74+
Usage: bazel-diff [-hkV] -b=<bazelPath> [-co=<bazelCommandOptions>]
7575
[-fh=<finalHashesJSONPath>] [-o=<outputPath>]
7676
[-sh=<startingHashesJSONPath>] [-so=<bazelStartupOptions>]
7777
-w=<workspacePath> [COMMAND]
7878
Writes to a file the impacted targets between two Bazel graph JSON files
7979
-b, --bazelPath=<bazelPath>
80-
Path to Bazel binary
80+
Path to Bazel binary
8181
-co, --bazelCommandOptions=<bazelCommandOptions>
82-
Additional space separated Bazel command options used when
83-
invoking Bazel
82+
Additional space separated Bazel command options used
83+
when invoking Bazel
8484
-fh, --finalHashes=<finalHashesJSONPath>
85-
The path to the JSON file of target hashes for the final
86-
revision. Run 'generate-hashes' to get this value.
87-
-h, --help Show this help message and exit.
85+
The path to the JSON file of target hashes for the
86+
final revision. Run 'generate-hashes' to get this
87+
value.
88+
-h, --help Show this help message and exit.
89+
-k, --[no-]keep_going This flag controls if `bazel query` will be executed
90+
with the `--keep_going` flag or not. Disabling this
91+
flag allows you to catch configuration issues in
92+
your Bazel graph, but may not work for some Bazel
93+
setups. Defaults to `true`
8894
-o, --output=<outputPath>
89-
Filepath to write the impacted Bazel targets to, newline
90-
separated
95+
Filepath to write the impacted Bazel targets to,
96+
newline separated
9197
-sh, --startingHashes=<startingHashesJSONPath>
92-
The path to the JSON file of target hashes for the initial
93-
revision. Run 'generate-hashes' to get this value.
98+
The path to the JSON file of target hashes for the
99+
initial revision. Run 'generate-hashes' to get this
100+
value.
94101
-so, --bazelStartupOptions=<bazelStartupOptions>
95-
Additional space separated Bazel client startup options used
96-
when invoking Bazel
97-
-V, --version Print version information and exit.
102+
Additional space separated Bazel client startup
103+
options used when invoking Bazel
104+
-V, --version Print version information and exit.
98105
-w, --workspacePath=<workspacePath>
99-
Path to Bazel workspace directory.
100-
Commands:
101-
generate-hashes Writes to a file the SHA256 hashes for each Bazel Target in
102-
the provided workspace.
106+
Path to Bazel workspace directory.
103107
```
104108

105109
`generate-hashes` Command
106110

107111
```terminal
108-
Usage: bazel-diff generate-hashes [-hV] -b=<bazelPath>
112+
Usage: bazel-diff generate-hashes [-hkV] -b=<bazelPath>
109113
[-co=<bazelCommandOptions>]
110114
[-s=<seedFilepaths>]
111115
[-so=<bazelStartupOptions>]
112116
-w=<workspacePath> <outputPath>
113117
Writes to a file the SHA256 hashes for each Bazel Target in the provided
114118
workspace.
115-
<outputPath> The filepath to write the resulting JSON of dictionary
116-
target => SHA-256 values
119+
<outputPath> The filepath to write the resulting JSON of
120+
dictionary target => SHA-256 values
117121
-b, --bazelPath=<bazelPath>
118-
Path to Bazel binary
122+
Path to Bazel binary
119123
-co, --bazelCommandOptions=<bazelCommandOptions>
120-
Additional space separated Bazel command options used when
121-
invoking Bazel
122-
-h, --help Show this help message and exit.
124+
Additional space separated Bazel command options used
125+
when invoking Bazel
126+
-h, --help Show this help message and exit.
127+
-k, --[no-]keep_going This flag controls if `bazel query` will be executed
128+
with the `--keep_going` flag or not. Disabling this
129+
flag allows you to catch configuration issues in
130+
your Bazel graph, but may not work for some Bazel
131+
setups. Defaults to `true`
123132
-s, --seed-filepaths=<seedFilepaths>
124-
A text file containing a newline separated list of
125-
filepaths, each of these filepaths will be read and used
126-
as a seed for all targets.
133+
A text file containing a newline separated list of
134+
filepaths, each of these filepaths will be read and
135+
used as a seed for all targets.
127136
-so, --bazelStartupOptions=<bazelStartupOptions>
128-
Additional space separated Bazel client startup options
129-
used when invoking Bazel
130-
-V, --version Print version information and exit.
137+
Additional space separated Bazel client startup
138+
options used when invoking Bazel
139+
-V, --version Print version information and exit.
131140
-w, --workspacePath=<workspacePath>
132-
Path to Bazel workspace directory.
141+
Path to Bazel workspace directory.
133142
```
134143

135144
## Installing

0 commit comments

Comments
 (0)