Skip to content

ci: Improve performance of go lint and formatting #4831

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

Draft
johnsaigle wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

ci: Improve performance of go lint and formatting #4831

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: 2 additions & 2 deletions node/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.PHONY: lint
lint:
golangci-lint run -c ../.golangci.yml ./...
lint:
golangci-lint run -c ../.golangci.yml --allow-parallel-runners ./...

.PHONY: test
test:
Expand Down
41 changes: 33 additions & 8 deletions scripts/lint.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,13 @@ format(){
exit 1
fi

# Use -exec because of pitfall #1 in http://mywiki.wooledge.org/BashPitfalls
GOFMT_OUTPUT="$(find "./sdk" "./node" "./wormchain" -type f -name '*.go' -not -path '*.pb.go' -print0 | xargs -r -0 goimports $GOIMPORTS_ARGS 2>&1)"

GOFMT_OUTPUT="$(git -C "$ROOT" ls-files -z --cached -- \
'sdk/*.go' \
'node/*.go' \
'wormchain/*.go' \
':(exclude)**/*.pb.go' \
| xargs -r -0 goimports $GOIMPORTS_ARGS 2>&1)"

if [ -n "$GOFMT_OUTPUT" ]; then
if [ "$GITHUB_ACTION" == "true" ]; then
Expand All @@ -55,25 +60,45 @@ format(){
}

lint(){
LINT_EXIT=0

# === Spell check
if ! command -v cspell >/dev/null 2>&1; then
printf "%s\n" "cspell is not installed. Skipping spellcheck"
else
cspell "*/**.*md"
cspell "*/**.*md" &
CSPELL_PID=$!
fi

# === Go linting
# Check for dependencies
if ! command -v golangci-lint >/dev/null 2>&1; then
printf "%s\n" "Require golangci-lint. You can run this command in a docker container instead with '-c' and not worry about it or install it: https://golangci-lint.run/usage/install/"
fi

# Do the actual linting!
cd "$ROOT"/node
golangci-lint run --timeout=10m $GOLANGCI_LINT_ARGS ./...
(
cd "$ROOT"/node
golangci-lint run --timeout=10m --allow-parallel-runners $GOLANGCI_LINT_ARGS ./...
) &
NODE_PID=$!

(
cd "${ROOT}/sdk"
golangci-lint run --timeout=10m --allow-parallel-runners $GOLANGCI_LINT_ARGS ./...
) &
SDK_PID=$!

wait $NODE_PID || LINT_EXIT=1
wait $SDK_PID || LINT_EXIT=1

if [ -n "${CSPELL_PID:-}" ]; then
wait $CSPELL_PID || LINT_EXIT=1
fi

cd "${ROOT}/sdk"
golangci-lint run --timeout=10m $GOLANGCI_LINT_ARGS ./...
if [ $LINT_EXIT -ne 0 ]; then
exit 1
fi
}

DOCKER="false"
Expand Down
Loading