Adds a simple Makefile with the most commonly used options

This will make it easier for people new to the project to figure
out how to contribute or test changes locally.

Signed-off-by: John Schnake <[email protected]>

Author: johnSchnake

Makefile

@@ -0,0 +1,19 @@
+.PHONY: build test update_golden help
+.DEFAULT_GOAL := help
+
+build: ## Builds the Sonobuoy binary for your local OS
+	# This is for local use; when building for other os/arch, use functions in ./scripts/build_funcs.sh directly.
+	@echo "Building the sonobuoy binary..."
+	go build
+	@echo "Complete. Use sonobuoy in the current working directory (e.g. ./sonobuoy)"
+
+test: ## Runs go tests
+	@echo "Running unit tests..."
+	source ./scripts/build_funcs.sh; unit_local
+
+golden: ## Runs go generate to produce version info
+	source ./scripts/build_funcs.sh; update_local
+	@echo "Run 'git status' and 'git diff' to see updated golden files."
+
+help:
+	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'

README.md

@@ -197,6 +197,24 @@ will be. Feel free to make comments on Github or start conversations in Slack.
 Thanks for taking the time to join our community and start contributing! We welcome pull requests. Feel free to dig
 through the [issues][issue] and jump in.
 
+The most common build/test functions are called via the Makefile:
+
+```
+// Build the binary
+$ make build
+
+// Run local unit tests
+$ make test
+```
+
+If you make changes which change output, you may fail tests which utilize the golden file testing pattern (e.g. correct data is stored in external files), update them by running:
+```
+$ make golden
+```
+
+In most cases, running integration tests is more simply done in CI when you open a pull request.
+You can dig into scripts/build_funcs.sh and our .github/workflows/ci-test.yaml for exact details of existing test flows.
+
 ### Before you start
 
 * Please familiarize yourself with the [Code of Conduct][coc] before contributing.

scripts/build_funcs.sh

@@ -364,9 +364,11 @@ load_test_images_into_cluster(){
 # tests so this will also build sonobuoy locally. A kind cluster won't be necessary.
 update_local() {
     set -x
-    # Download linux kubectl and move into default path for tests
-    curl --output ./kubectl https://storage.googleapis.com/kubernetes-release/release/v1.23.0/bin/linux/amd64/kubectl
-    chmod +x ./kubectl
+    if [ -f "./kubectl" ]; then
+      # Download linux kubectl and move into default path for tests
+      curl --output ./kubectl https://storage.googleapis.com/kubernetes-release/release/v1.23.0/bin/linux/amd64/kubectl
+      chmod +x ./kubectl
+    fi
 
     # Redirect output so we can avoid clutter where go is telling us where -update
     # is not defined. Just printing out the packages at the end.

site/content/docs/main/_index.md

@@ -52,10 +52,6 @@ more about the new release cycles in [our blog][decoupling-sonobuoy-k8s].
 
    Move the extracted `sonobuoy` executable to somewhere on your `PATH`.
 
-## CLI Documentation
-
-The full documentation for the CLI can be found [here][clidocs].
-
 ## Getting Started
 
 To launch conformance tests (ensuring [CNCF][cncf] conformance) and wait until they are finished run:
@@ -207,6 +203,24 @@ will be. Feel free to make comments on Github or start conversations in Slack.
 Thanks for taking the time to join our community and start contributing! We welcome pull requests. Feel free to dig
 through the [issues][issue] and jump in.
 
+The most common build/test functions are called via the Makefile:
+
+```
+// Build the binary
+$ make build
+
+// Run local unit tests
+$ make test
+```
+
+If you make changes which change output, you may fail tests which utilize the golden file testing pattern (e.g. correct data is stored in external files), update them by running:
+```
+$ make golden
+```
+
+In most cases, running integration tests is more simply done in CI when you open a pull request.
+You can dig into scripts/build_funcs.sh and our .github/workflows/ci-test.yaml for exact details of existing test flows.
+
 ### Before you start
 
 * Please familiarize yourself with the [Code of Conduct][coc] before contributing.
@@ -269,7 +283,4 @@ See [the list of releases][releases] to find out about feature changes.
 
 [aggregator-permissions]: aggregator-permissions
 
-[clidocs]: cli/sonobuoy
-
-[roadmap]: https://github.com/vmware-tanzu/sonobuoy/wiki/Roadmap
-
+[roadmap]: https://github.com/vmware-tanzu/sonobuoy/wiki/Roadmap