docs: update readme

Author: psturc

README.md

@@ -18,9 +18,14 @@ run `make dist` to build for all supported architectures.
 
 ## Testing
 
-Run `make test` to run the unit tests, and `make acceptance` to run the
+Run `make test` to run the unit tests, and `E2E_INSTRUMENTATION=true make acceptance` to run the
 acceptance tests.
 
+The purpose of the `E2E_INSTRUMENTATION=true` environment variable is to pass
+extra flags to the build command. This instruments the resulting binary,
+allowing for the collection of coverage data during the acceptance test run.
+(more information here: https://go.dev/doc/build-cover).
+
 ## Linting
 
 Run `make lint` to check for linting issues, and `make lint-fix` to fix linting

acceptance/README.md

@@ -14,7 +14,7 @@ uses the established Go test to launch Godog.
 
 To run the acceptance tests either run:
 
-    $ make acceptance
+    $ E2E_INSTRUMENTATION=true make acceptance
 
 from the root of the repository.
 
@@ -64,7 +64,7 @@ Docker website how to accomplish that.
 ## Debugging
 
 The acceptance tests execute the `ec` binary during test execution. (For this
-reason `make acceptance` builds the binary prior to running the tests.)
+reason `E2E_INSTRUMENTATION=true make acceptance` builds the binary prior to running the tests.)
 
 To use a debugger, like [delve](https://github.com/go-delve/delve), you must
 determine what part of the code is being debugged. If it's part of the

hack/macos/TROUBLESHOOTING.md

@@ -102,7 +102,7 @@ podman machine start
 
 ```bash
 # Run all acceptance tests
-make acceptance
+E2E_INSTRUMENTATION=true make acceptance
 
 # Or run tests directly
 cd acceptance

hack/macos/setup-podman-machine.sh

@@ -305,7 +305,7 @@ main() {
     echo
     echo "To run acceptance tests:"
     echo "  1. Source the environment: source setup-test-env.sh"
-    echo "  2. Run tests: make acceptance"
+    echo "  2. Run tests: E2E_INSTRUMENTATION=true make acceptance"
     echo "     or: cd acceptance && go test -v ./..."
     echo
     echo "Environment variables are saved in: setup-test-env.sh"