Merge pull request #127 from LukeWinikates/make-godoc

add make godoc target so new contributors can easily review godoc
wavefrontHQ · Dec 16, 2022 · 373ef2f · 373ef2f
2 parents 2e71c31 + 33d4d16
commit 373ef2f
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 1 deletion.
diff --git a/Makefile b/Makefile
@@ -1,3 +1,10 @@
+.PHONY: test godoc
+
 test:
 	go test -timeout 10m -v -race ./...
-	go vet ./...
+	go vet ./...
+
+godoc:
+	scripts/godoc-install-hint.sh
+	@echo "\n\nlaunching godoc server. see docs here: http://localhost:6060/pkg/github.com/wavefronthq/wavefront-sdk-go/senders \n\n"
+	godoc -http=:6060
diff --git a/scripts/godoc-install-hint.sh b/scripts/godoc-install-hint.sh
@@ -0,0 +1,12 @@
+#!/usr/bin/env bash
+set -eou pipefail
+
+which godoc >/dev/null || (
+  cat <<-'EOF'
+The godoc cli is not installed.
+Install godoc somewhere on your $PATH.
+
+For example, if /usr/local/bin is on your $PATH:
+  GOBIN=/usr/local/bin/ go install golang.org/x/tools/cmd/godoc@latest
+EOF
+)