Files
external-snapshotter/verify-spelling.sh
Patrick Ohly 336f826a6f Squashed 'release-tools/' changes from 3b6d17b1..1d60e779
1d60e779 Merge pull request #131 from pohly/kubernetes-1.20-tag
9f104590 prow.sh: support building Kubernetes for a specific version
fe1f2848 Merge pull request #121 from kvaps/namespace-check
8fdf0f78 Merge pull request #128 from fengzixu/master
1c94220d fix: fix a bug of csi-sanity
a4c41e6a Merge pull request #127 from pohly/fix-boilerplate
ece0f500 check namespace for snapshot-controller
dbd89672 verify-boilerplate.sh: fix path to script
9289fd16 Merge pull request #125 from sachinkumarsingh092/optional-spelling-boilerplate-checks
ad29307f Make the spelling and boilerplate checks optional
5f06d024 Merge pull request #124 from sachinkumarsingh092/fix-spellcheck-boilerplate-tests
48186eba Fix spelling and boilerplate errors
71690aff Merge pull request #122 from sachinkumarsingh092/include-spellcheck-boilerplate-tests
981be3fe Adding spelling and boilerplate checks.
2bb75253 Merge pull request #117 from fengzixu/master
4ab8b154 use the tag to replace commit of csi-test
5d74e455 change the csi-test import path to v4
7dcd0a99 upgrade csi-test to v4.0.2

git-subtree-dir: release-tools
git-subtree-split: 1d60e7792624a9938c0bd1b045211fbb89e513d6
2021-01-26 21:10:05 +01:00

60 lines
1.8 KiB
Bash
Executable File

#!/usr/bin/env bash
# Copyright 2019 The Kubernetes Authors.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
set -o errexit
set -o nounset
set -o pipefail
TOOL_VERSION="v0.3.4"
# The csi-release-tools directory (absolute path).
TOOLS="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd -P)"
# Directory to check. Default is the parent of the tools themselves.
ROOT="${1:-${TOOLS}/..}"
# create a temporary directory
TMP_DIR=$(mktemp -d)
# cleanup
exitHandler() (
echo "Cleaning up..."
rm -rf "${TMP_DIR}"
)
trap exitHandler EXIT
if [[ -z "$(command -v misspell)" ]]; then
echo "Cannot find misspell. Installing misspell..."
# perform go get in a temp dir as we are not tracking this version in a go module
# if we do the go get in the repo, it will create / update a go.mod and go.sum
cd "${TMP_DIR}"
GO111MODULE=on GOBIN="${TMP_DIR}" go get "github.com/client9/misspell/cmd/misspell@${TOOL_VERSION}"
export PATH="${TMP_DIR}:${PATH}"
fi
# check spelling
RES=0
echo "Checking spelling..."
ERROR_LOG="${TMP_DIR}/errors.log"
cd "${ROOT}"
git ls-files | grep -v vendor | xargs misspell > "${ERROR_LOG}"
if [[ -s "${ERROR_LOG}" ]]; then
sed 's/^/error: /' "${ERROR_LOG}" # add 'error' to each line to highlight in e2e status
echo "Found spelling errors!"
RES=1
fi
exit "${RES}"