Add spellcheck tests

Gopkg.toml

@@ -21,6 +21,7 @@
 
 # Code generation dependencies
 required = [
+  "github.com/client9/misspell/cmd/misspell",
   "k8s.io/code-generator/cmd/client-gen",
   "k8s.io/code-generator/cmd/conversion-gen",
   "k8s.io/code-generator/cmd/deepcopy-gen",

Makefile

@@ -50,6 +50,8 @@ all: build
 test: build-dirs Makefile
 	@echo "Testing: $(SRC_DIRS)"
 	PKG=$(PKG) ./hack/test.sh $(SRC_DIRS)
+	@echo "Running Spellchecker"
+	./hack/spellcheck.sh
 
 .PHONY: build-dirs
 build-dirs:

docs/development.md

@@ -18,7 +18,7 @@ $ make push
 The resulting tag for the container image will be named as the agent version
 in the format of `$USER-TIMESTAMP`. This will need to be remembered as this is
 needed for a latter step or can be exported as the `$MYSQL_AGENT_VERSION`
-envrionment variable.
+environment variable.
 
 ```bash
 $ export MYSQL_AGENT_VERSION=$(cat dist/version.txt)
@@ -42,7 +42,7 @@ ServiceAccounts, ClusterRoles, and ClusterRoleBindings for the operator to
 function.
 
 ```bash
-$ kubectl -n $USER apply -f contrib/manifests/custom-resource-definitions.yaml 
+$ kubectl -n $USER apply -f contrib/manifests/custom-resource-definitions.yaml
 ```
 ```bash
 $ sed -e "s/<NAMESPACE>/${USER}/g" contrib/manifests/rbac.yaml | kubectl -n $USER apply -f -

docs/user/config.md

@@ -10,7 +10,7 @@ Some aspects of the MySQL Operator can be configured via:
 When applicable, a commandline parameter will override the equivalent config
 map parameter.
 
-Most of the time it should not be neccessary to supply any specific
+Most of the time it should not be necessary to supply any specific
 configuration and the operator will use sensible defaults when required
 values are not specified.
 

hack/spellcheck.sh

@@ -0,0 +1,14 @@
+#!/usr/bin/env bash
+#
+# Performs a spellcheck on golang and markdown files, excluding the vendor directory
+
+set -e
+
+REPO_ROOT=$(git rev-parse --show-toplevel)
+REPO_BIN_DIR="${REPO_ROOT}/bin"
+
+cd "${REPO_ROOT}"
+GOBIN="${REPO_BIN_DIR}" go install ./vendor/github.com/client9/misspell/cmd/misspell
+
+find . -type f \( -name "*.go" -o -name "*.md" \) -a \( -not -path "./vendor/*" \) | \
+  xargs ${REPO_BIN_DIR}/misspell -error