Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

make lint runs shellcheck on shell scripts as well #1345

Merged
merged 1 commit into from
Dec 14, 2023
Merged

make lint runs shellcheck on shell scripts as well #1345

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions images/capi/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -184,6 +184,7 @@ deps-lint: ## Installs/checks dependencies for image-builder code linting
deps-lint: deps-common
hack/ensure-ansible-windows.sh
hack/ensure-ansible-lint.sh
hack/ensure-shellcheck.sh

## --------------------------------------
## Container variables
Expand Down Expand Up @@ -967,8 +968,11 @@ validate-all: ## Validates the Packer config for all build targets

.PHONY: lint
lint: ## Runs linters on image-builder code
sh_files = $(shell find . -type f -name "*.sh")
lint: deps-lint
ansible-lint ansible/
# ignore error code since shellcheck exits with Error 1 if problems are found despite running properly
-@for f in $(sh_files); do (shellcheck -x $$f); done
NotAName320 marked this conversation as resolved.
Show resolved Hide resolved

.PHONY: lint-fix
lint-fix: ## Runs linters on image-builder code and fixes issues
Expand Down
36 changes: 36 additions & 0 deletions images/capi/hack/ensure-shellcheck.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
#!/usr/bin/env bash

# Copyright 2023 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

[[ -n ${DEBUG:-} ]] && set -o xtrace

scversion="stable"

if [[ "$OSTYPE" == "darwin"* ]]; then
operatingsystem="darwin.x86_64"
else
operatingsystem="linux.x86_64"
fi

if command -v shellcheck >/dev/null 2>&1; then exit 0; fi

wget -qO- "https://github.com/koalaman/shellcheck/releases/download/${scversion?}/shellcheck-${scversion?}.${operatingsystem?}.tar.xz" | tar -xJv
cp "shellcheck-${scversion}/shellcheck" ~/.local/bin/
rm -rf "./shellcheck-${scversion}"
shellcheck --version