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

Add lint make target #1068

Merged
merged 9 commits into from
Nov 3, 2022
Merged

Add lint make target #1068

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
d88d1b3
Add lint make target
cartermckinnon Oct 29, 2022
23a6d37
Add shellcheck
cartermckinnon Oct 29, 2022
b1bbb83
fix line break issue
cartermckinnon Oct 29, 2022
2ddca45
Enable lint in CI
cartermckinnon Oct 31, 2022
9fbe089
Ensure go/bin is on PATH
cartermckinnon Oct 31, 2022
afb52fe
Add fallback to shellcheck in container
cartermckinnon Nov 2, 2022
0758830
Merge branch 'master' into lint
cartermckinnon Nov 2, 2022
ba66518
Merge branch 'master' into lint
cartermckinnon Nov 3, 2022
9889d89
Merge branch 'master' into lint
cartermckinnon Nov 3, 2022
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
7 changes: 7 additions & 0 deletions .github/workflows/ci.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,13 @@ on:
- reopened
- synchronize
jobs:
lint:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- run: echo "$(go env GOPATH)/bin" >> $GITHUB_PATH
- run: go install mvdan.cc/sh/v3/cmd/shfmt@latest
- run: make lint
test:
runs-on: ubuntu-latest
steps:
Expand Down
11 changes: 11 additions & 0 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,17 @@ endif
fmt: ## Format the source files
$(SHFMT_COMMAND) $(SHFMT_FLAGS) --write $(MAKEFILE_DIR)

SHELLCHECK_COMMAND := $(shell which shellcheck)
ifeq (, $(SHELLCHECK_COMMAND))
SHELLCHECK_COMMAND = docker run --rm -v $(MAKEFILE_DIR):$(MAKEFILE_DIR) koalaman/shellcheck:stable
endif
SHELL_FILES := $(shell find $(MAKEFILE_DIR) -type f -name '*.sh')

.PHONY: lint
lint: ## Check the source files for syntax and format issues
$(SHFMT_COMMAND) $(SHFMT_FLAGS) --diff $(MAKEFILE_DIR)
$(SHELLCHECK_COMMAND) --format gcc --severity error $(SHELL_FILES)

.PHONY: test
test: ## run the test-harness
test/test-harness.sh
Expand Down