This repository has been archived by the owner on Jul 16, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 91
Adds gofmt verification #485
Merged
Merged
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
name: Code format verify | ||
|
||
on: | ||
push: | ||
branches: | ||
- master | ||
pull_request: | ||
branches: | ||
— master | ||
|
||
jobs: | ||
gofmt: | ||
name: Run gofmt verify | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: Setup Go | ||
uses: actions/setup-go@v2 | ||
with: | ||
go-version: '1.19' | ||
stable: 'false' | ||
|
||
- name: Install dependencies | ||
run: | | ||
go version | ||
go install golang.org/x/lint/golint@latest | ||
- name: checkout | ||
uses: actions/checkout@v2 | ||
|
||
- name: run gofmt tests | ||
run: ./hack/verify-gofmt.sh |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
#!/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. | ||
|
||
# GoFmt apparently is changing @ head... | ||
|
||
set -o errexit | ||
set -o nounset | ||
set -o pipefail | ||
|
||
ROOT=$(dirname "${BASH_SOURCE[0]}")/.. | ||
|
||
cd "${ROOT}" | ||
|
||
function git_find() { | ||
# Similar to find but faster and easier to understand. We want to include | ||
# modified and untracked files because this might be running against code | ||
# which is not tracked by git yet. | ||
git ls-files -cmo --exclude-standard \ | ||
':!:vendor/*' `# catches vendor/...` \ | ||
':!:*/vendor/*' `# catches any subdir/vendor/...` \ | ||
':!:third_party/*' `# catches third_party/...` \ | ||
':!:*/third_party/*' `# catches third_party/...` \ | ||
':(glob)**/*.go' \ | ||
"$@" | ||
} | ||
|
||
git_find -z | xargs -0 gofmt -s -w |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,57 @@ | ||
#!/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. | ||
|
||
# This script checks whether the source code needs to be formatted or not by | ||
# `gofmt`. Run `hack/update-gofmt.sh` to actually format sources. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. What about bring some notes in the README, and clarify the difference between both. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Sure Amim added to README |
||
# | ||
# Note: gofmt output can change between go versions. | ||
# | ||
# Usage: `hack/verify-gofmt.sh`. | ||
|
||
set -o errexit | ||
set -o nounset | ||
set -o pipefail | ||
|
||
ROOT=$(dirname "${BASH_SOURCE[0]}")/.. | ||
|
||
cd "${ROOT}" | ||
|
||
find_files() { | ||
find . -not \( \ | ||
\( \ | ||
-wholename './output' \ | ||
-o -wholename './.git' \ | ||
-o -wholename './_output' \ | ||
-o -wholename './_gopath' \ | ||
-o -wholename './release' \ | ||
-o -wholename './target' \ | ||
-o -wholename '*/third_party/*' \ | ||
-o -wholename '*/vendor/*' \ | ||
\) -prune \ | ||
\) -name '*.go' | ||
} | ||
|
||
# gofmt exits with non-zero exit code if it finds a problem unrelated to | ||
# formatting (e.g., a file does not parse correctly). Without "|| true" this | ||
# would have led to no useful error message from gofmt, because the script would | ||
# have failed before getting to the "echo" in the block below. | ||
diff=$(find_files | xargs gofmt -d -s 2>&1) || true | ||
if [[ -n "${diff}" ]]; then | ||
echo "${diff}" >&2 | ||
echo >&2 | ||
echo "Run ./hack/update-gofmt.sh" >&2 | ||
gitvinit marked this conversation as resolved.
Show resolved
Hide resolved
|
||
exit 1 | ||
fi |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
for the future, these kind of linters are better integrated in the IDE, we can update the readme on a next moment with the instructions
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sure sounds good