ci: Add spell checker to ci (envoyproxy#4439)

Correct commonly misspelled English words

Signed-off-by: zyfjeff <[email protected]>

Author: zyfjeff

.circleci/config.yml

@@ -114,6 +114,7 @@ jobs:
        - run: rm -rf /home/circleci/project/.git # CircleCI git caching is likely broken
        - checkout
        - run: ci/do_circle_ci.sh check_format
+       - run: ci/do_circle_ci.sh check_spelling
    build_image:
      docker:
        - image: circleci/python:2.7

CONTRIBUTING.md

@@ -212,7 +212,7 @@ git rebase -i HEAD^^
 git push origin -f
 ```
 
-Note, that in general rewriting history in this way is a hinderance to the review process and this
+Note, that in general rewriting history in this way is a hindrance to the review process and this
 should only be done to correct a DCO mistake.
 
 ## Triggering CI re-run without making changes

api/envoy/api/v2/listener/listener.proto

@@ -61,7 +61,7 @@ message Filter {
 // 4. Transport protocol.
 // 5. Application protocols (e.g. ALPN for TLS protocol).
 //
-// For criterias that allow ranges or wildcards, the most specific value in any
+// For criteria that allow ranges or wildcards, the most specific value in any
 // of the configured filter chains that matches the incoming connection is going
 // to be used (e.g. for SNI ``www.example.com`` the most specific match would be
 // ``www.example.com``, then ``*.example.com``, then ``*.com``, then any filter

api/envoy/config/filter/http/jwt_authn/v2alpha/README.md

@@ -26,6 +26,6 @@ The next default location is in the query parameter as:
 
 If a custom location is desired, `from_headers` or `from_params` can be used to specify custom locations to extract JWT.
 
-## HTTP header to pass sucessfully verified JWT
+## HTTP header to pass successfully verified JWT
 
 If a JWT is valid, its payload will be passed to the backend in a new HTTP header specified in `forward_payload_header` field. Its value is base64 encoded JWT payload in JSON.

api/envoy/config/filter/network/http_connection_manager/v2/http_connection_manager.proto

@@ -219,7 +219,7 @@ message HttpConnectionManager {
     bool unix_sockets = 1;
   }
 
-  // Configures what network addresses are considered internal for stats and header sanitazion
+  // Configures what network addresses are considered internal for stats and header sanitation
   // purposes. If unspecified, only RFC1918 IP addresses will be considered internal.
   // See the documentation for :ref:`config_http_conn_man_headers_x-envoy-internal` for more
   // information about internal/external addresses.

api/envoy/config/rbac/v2alpha/rbac.proto

@@ -108,7 +108,7 @@ message Permission {
     // When any is set, it matches any action.
     bool any = 3 [(validate.rules).bool.const = true];
 
-    // A header (or psuedo-header such as :path or :method) on the incoming HTTP request. Only
+    // A header (or pseudo-header such as :path or :method) on the incoming HTTP request. Only
     // available for HTTP request.
     envoy.api.v2.route.HeaderMatcher header = 4;
 
@@ -166,7 +166,7 @@ message Principal {
     // A CIDR block that describes the downstream IP.
     envoy.api.v2.core.CidrRange source_ip = 5;
 
-    // A header (or psuedo-header such as :path or :method) on the incoming HTTP request. Only
+    // A header (or pseudo-header such as :path or :method) on the incoming HTTP request. Only
     // available for HTTP request.
     envoy.api.v2.route.HeaderMatcher header = 6;
 

bazel/PPROF.md

@@ -83,7 +83,7 @@ instantiation of `MainCommonBase::MainCommonBase`:
 
 Once these changes have been made in your working directory, it might make sense to
 save the diff as a patch (`git diff > file`), which can then be quickly
-applied/unapplied for testing and commiting. (`git apply`, `git apply -R`)
+applied/unapplied for testing and committing. (`git apply`, `git apply -R`)
 
 Build the binary using bazel, and run the binary without any environment variables:
 

bazel/get_workspace_status

@@ -37,7 +37,7 @@ fi
 echo "BUILD_SCM_REVISION ${git_rev}"
 echo "STABLE_BUILD_SCM_REVISION ${git_rev}"
 
-# Check whether there are any uncommited changes
+# Check whether there are any uncommitted changes
 git diff-index --quiet HEAD --
 if [[ $? == 0 ]];
 then

bazel/repositories.bzl

@@ -195,7 +195,7 @@ def _python_deps():
         build_file = "@envoy//bazel/external:twitter_common_finagle_thrift.BUILD",
     )
 
-# Bazel native C++ dependencies. For the depedencies that doesn't provide autoconf/automake builds.
+# Bazel native C++ dependencies. For the dependencies that doesn't provide autoconf/automake builds.
 def _cc_deps():
     _repository_impl("grpc_httpjson_transcoding")
     native.bind(

ci/README.md

@@ -87,9 +87,11 @@ The `./ci/run_envoy_docker.sh './ci/do_ci.sh <TARGET>'` targets are:
 * `bazel.release.server_only` &mdash; build Envoy static binary under `-c opt` with gcc.
 * `bazel.coverage` &mdash; build and run tests under `-c dbg` with gcc, generating coverage information in `$ENVOY_DOCKER_BUILD_DIR/envoy/generated/coverage/coverage.html`.
 * `bazel.coverity` &mdash; build Envoy static binary and run Coverity Scan static analysis.
-* `bazel.tsan` &mdash; build and run tests under `-c dbg --config=clang-tsan` with clang.
-* `check_format`&mdash; run `clang-format` and `buildifier` on entire source tree.
-* `fix_format`&mdash; run and enforce `clang-format` and `buildifier` on entire source tree.
+* `bazel.tsan` &mdash; build and run tests under `-c dbg --config=clang-tsan` with clang-6.0.
+* `check_format`&mdash; run `clang-format-6.0` and `buildifier` on entire source tree.
+* `fix_format`&mdash; run and enforce `clang-format-6.0` and `buildifier` on entire source tree.
+* `check_spelling`&mdash; run `misspell` on entire project.
+* `fix_spelling`&mdash; run and enforce `misspell` on entire project.
 * `docs`&mdash; build documentation tree in `generated/docs`.
 
 # Testing changes to the build image as a developer