nit: doc gazelle_generation_test use of arguments.txt (bazel-cont…

…rib#1660) * nit: doc `gazelle_generation_test` use of `arguments.txt` Add top-level documentation of `arguments.txt`. This was in the code comments but not documented in `extend.md`. * fix via skylark docs
jeromep-stripe · Mar 22, 2024 · 223c9d3 · 223c9d3
1 parent 624be58
commit 223c9d3
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 0 deletions.
diff --git a/extend.md b/extend.md
@@ -157,6 +157,7 @@ The generation test expects a file structure like the following:
     |-- some_test
         |-- WORKSPACE
         |-- README.md --&gt; README describing what the test does.
+        |-- arguments.txt --&gt; newline delimited list of arguments to pass in (ignored if empty).
         |-- expectedStdout.txt --&gt; Expected stdout for this test.
         |-- expectedStderr.txt --&gt; Expected stderr for this test.
         |-- expectedExitCode.txt --&gt; Expected exit code for this test.

diff --git a/internal/generationtest/generationtest.bzl b/internal/generationtest/generationtest.bzl
@@ -29,6 +29,7 @@ def gazelle_generation_test(name, gazelle_binary, test_data, build_in_suffix = "
         |-- some_test
             |-- WORKSPACE
             |-- README.md --> README describing what the test does.
+            |-- arguments.txt --> newline delimited list of arguments to pass in (ignored if empty).
             |-- expectedStdout.txt --> Expected stdout for this test.
             |-- expectedStderr.txt --> Expected stderr for this test.
             |-- expectedExitCode.txt --> Expected exit code for this test.