Skip to content

Commit

Permalink
Drop extraneous update prefix.
Browse files Browse the repository at this point in the history
  • Loading branch information
amwat committed Jun 11, 2019
1 parent d5380ed commit 1baa8ef
Show file tree
Hide file tree
Showing 6 changed files with 10 additions and 10 deletions.
6 changes: 3 additions & 3 deletions hack/update/update-all.sh → hack/update/all.sh
Expand Up @@ -20,6 +20,6 @@ set -o pipefail

REPO_ROOT=$(git rev-parse --show-toplevel)

"${REPO_ROOT}"/hack/update/update-deps.sh
"${REPO_ROOT}"/hack/update/update-generated.sh
"${REPO_ROOT}"/hack/update/update-gofmt.sh
"${REPO_ROOT}"/hack/update/deps.sh
"${REPO_ROOT}"/hack/update/generated.sh
"${REPO_ROOT}"/hack/update/gofmt.sh
2 changes: 1 addition & 1 deletion hack/update/update-deps.sh → hack/update/deps.sh
Expand Up @@ -17,7 +17,7 @@
# Runs go mod tidy, go mod vendor, and then prun vendor
#
# Usage:
# update-deps.sh
# deps.sh

set -o nounset
set -o errexit
Expand Down
File renamed without changes.
File renamed without changes.
4 changes: 2 additions & 2 deletions hack/verify/generated.sh
Expand Up @@ -67,11 +67,11 @@ main() {
-x "vendor" \
"${REPO_ROOT}" "${TMP_REPO}" 2>/dev/null || true)
if [[ -n "${diff}" ]]; then
echo "unexpectedly dirty working directory after hack/update/update-generated.sh" >&2
echo "unexpectedly dirty working directory after hack/update/generated.sh" >&2
echo "" >&2
echo "${diff}" >&2
echo "" >&2
echo "please run hack/update/update-generated.sh" >&2
echo "please run hack/update/generated.sh" >&2
exit 1
fi
}
Expand Down
8 changes: 4 additions & 4 deletions site/content/docs/contributing/project-structure.md
Expand Up @@ -62,23 +62,23 @@ You can check the compliance of the entire project by running the `verify-all.sh

### Update
In order to get the project’s source code into a compilable state, the script
**[update-all.sh](https://sigs.k8s.io/kind/hack/update/update-all.sh)** performs the following tasks:
**[update-all.sh](https://sigs.k8s.io/kind/hack/update/all.sh)** performs the following tasks:

* runs update-deps.sh to obtain all of the project’s dependencies
* runs update-generated.sh to generate code necessary to generate Kubernetes API code for kind, see https://kind.sigs.k8s.io/docs/user/quick-start/#configuring-your-kind-cluster
* runs update-gofmt.sh which formats all Go source code using the Go fmt tool.

Let’s go a little in depth on each of these files.

**[update-deps.sh](https://sigs.k8s.io/kind/hack/update/update-deps.sh)** performs the following steps:
**[update-deps.sh](https://sigs.k8s.io/kind/hack/update/deps.sh)** performs the following steps:

* runs `go mod tidy` to remove any no-longer-needed dependencies from go.mod and add any dependencies needed for other combinations of OS, architecture, and build tags
* runs `go mod vendor`, which re-populates the vendor directory, resets the main module's vendor directory to include all packages needed to build and test all of the module's packages based on the state of the go.mod files and Go source code.
* finally, it prunes the vendor directory of any unnecessary files (keeps code source files, licenses, author files, etc).

**[update-gofmt.sh](https://sigs.k8s.io/kind/hack/update/update-gofmt.sh)** runs gofmt on all nonvendored source code to format and simplify the code.
**[update-gofmt.sh](https://sigs.k8s.io/kind/hack/update/gofmt.sh)** runs gofmt on all nonvendored source code to format and simplify the code.

**[update-generated.sh](https://sigs.k8s.io/kind/hack/update/update-generated.sh)** in short, generates Go source code that is necessary to use a Kubernetes-style resource definition to define a schema that can be use to configure Kind.
**[update-generated.sh](https://sigs.k8s.io/kind/hack/update/generated.sh)** in short, generates Go source code that is necessary to use a Kubernetes-style resource definition to define a schema that can be use to configure Kind.

Going a bit more in depth, update-generated.sh does the following:

Expand Down

0 comments on commit 1baa8ef

Please sign in to comment.