Skip to content

Commit

Permalink
Move go mod tidying/verification to hack scripts
Browse files Browse the repository at this point in the history
Signed-off-by: Andy Goldstein <[email protected]>
  • Loading branch information
ncdc committed Jan 24, 2023
1 parent 4fcafc2 commit 69462e7
Show file tree
Hide file tree
Showing 3 changed files with 69 additions and 6 deletions.
8 changes: 2 additions & 6 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -371,15 +371,11 @@ verify-go-versions:

.PHONY: modules
modules: ## Run go mod tidy to ensure modules are up to date
go mod tidy
cd pkg/apis; go mod tidy
hack/update-go-modules.sh

.PHONY: verify-modules
verify-modules: modules ## Verify go modules are up to date
@if !(git diff --quiet HEAD -- go.sum go.mod pkg/apis/go.mod pkg/apis/go.sum); then \
git diff; \
echo "go module files are out of date"; exit 1; \
fi
hack/verify-go-modules.sh

.PHONY: clean
clean:
Expand Down
30 changes: 30 additions & 0 deletions hack/update-go-modules.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
#!/usr/bin/env bash

# Copyright 2023 The KCP 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 tidies all go modules in the repository.

set -o errexit
set -o nounset
set -o pipefail

REPO_ROOT=$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)

mapfile -t DIRS < <(find "${REPO_ROOT}" -name go.mod -print0 | xargs -0 dirname)

for dir in "${DIRS[@]}"; do
echo "Tidying ${dir}"
go mod tidy
done
37 changes: 37 additions & 0 deletions hack/verify-go-modules.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
#!/usr/bin/env bash

# Copyright 2023 The KCP 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 verifies all go modules in the repository.

set -o errexit
set -o nounset
set -o pipefail

REPO_ROOT=$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)

mapfile -t DIRS < <(find "${REPO_ROOT}" -name go.mod -print0 | xargs -0 dirname)

for dir in "${DIRS[@]}"; do
(
cd "$dir"
echo "Verifying ${dir}"
if ! git diff --quiet HEAD -- go.mod go.sum; then
echo "go module files are out of date"
git diff HEAD -- go.mod go.sum
exit 1
fi
)
done

0 comments on commit 69462e7

Please sign in to comment.