adding version info to plugin (#89)

Author: psschwei

hack/README.md

@@ -16,6 +16,21 @@
 
 set -o pipefail
 
+# =================================================
+# CUSTOMIZE ME:
+
+# Name of the plugin
+PLUGIN="kn-quickstart"
+
+# Directories containing go code which needs to be formatted
+SOURCE_DIRS="cmd pkg internal"
+
+# Directory which should be compiled
+MAIN_SOURCE_DIR="cmd"
+
+# Package which holds the version variables
+VERSION_PACKAGE="knative.dev/kn-plugin-quickstart/internal/command"
+
 # =================================================
 
 # Store for later
@@ -92,6 +107,12 @@ run() {
 
 
 codegen() {
+  #TODO: Workaround to update go-licenses until prow-tests image is updated
+  local temp_dir="$(mktemp -d)"
+  pushd "${temp_dir}" > /dev/null 2>&1
+  GO111MODULE=on go get github.com/google/go-licenses@latest || return 1
+  popd > /dev/null 2>&1
+
   # Update dependencies
   update_deps
 
@@ -102,32 +123,32 @@ codegen() {
   check_license
 }
 
-go_fmt() {
-  echo "🧹 ${S}Format"
-  find $(echo $SOURCE_DIRS) -name "*.go" -print0 | xargs -0 gofmt -s -w
+# Run a go tool, get it first if necessary.
+run_go_tool() {
+  local tool=$2
+  local install_failed=0
+  if [ -z "$(which ${tool})" ]; then
+    local temp_dir="$(mktemp -d)"
+    pushd "${temp_dir}" > /dev/null 2>&1
+    GOFLAGS="" go get "$1" || install_failed=1
+    popd > /dev/null 2>&1
+    rm -rf "${temp_dir}"
+  fi
+  (( install_failed )) && return ${install_failed}
+  shift 2
+  ${tool} "$@"
 }
 
 source_format() {
   set +e
-  which goimports >/dev/null 2>&1
-  if [ $? -ne 0 ]; then
-     echo "✋ No 'goimports' found. Please use"
-     echo "✋   go install golang.org/x/tools/cmd/goimports"
-     echo "✋ to enable import cleanup. Import cleanup skipped."
-
-     # Run go fmt instead
-     go_fmt
-  else
-     echo "🧽 ${X}Format"
-     goimports -w $(echo $SOURCE_DIRS)
-     find $(echo $SOURCE_DIRS) -name "*.go" -print0 | xargs -0 gofmt -s -w
-  fi
+  run_go_tool golang.org/x/tools/cmd/goimports goimports -w $(echo $SOURCE_DIRS)
+  find $(echo $SOURCE_DIRS) -name "*.go" -print0 | xargs -0 gofmt -s -w
   set -e
 }
 
 go_build() {
   echo "🚧 Compile"
-  go build -ldflags "$(build_flags $(basedir))" -o $PLUGIN "./$MAIN_SOURCE_DIR/..."
+  go build -mod=vendor -ldflags "$(build_flags $(basedir))" -o $PLUGIN "./$MAIN_SOURCE_DIR/..."
 }
 
 go_test() {
@@ -143,7 +164,7 @@ go_test() {
 
   echo "🧪 ${X}Test"
   set +e
-  go test -v ./pkg/... ./internal/... >$test_output 2>&1
+  go test -v ./pkg/... >$test_output 2>&1
   local err=$?
   if [ $err -ne 0 ]; then
     echo "🔥 ${red}Failure${reset}"
@@ -183,8 +204,7 @@ check_license() {
 
 update_deps() {
   echo "🚒 Update"
-  go mod tidy
-  go mod vendor
+  $(basedir)/hack/update-deps.sh
 }
 
 watch() {
@@ -259,17 +279,12 @@ cross_build() {
 
   export CGO_ENABLED=0
   echo "   🐧 ${PLUGIN}-linux-amd64"
-  GOOS=linux GOARCH=amd64 go build -ldflags "${ld_flags}" -o ./${PLUGIN}-linux-amd64 "./$MAIN_SOURCE_DIR/..."|| failed=1
-  echo "   💪 ${PLUGIN}-linux-arm64"
-  GOOS=linux GOARCH=arm64 go build -mod=vendor -ldflags "${ld_flags}" -o ./${PLUGIN}-linux-arm64 ./cmd/... || failed=1
+  GOOS=linux GOARCH=amd64 go build -mod=vendor -ldflags "${ld_flags}" -o ./${PLUGIN}-linux-amd64 "./$MAIN_SOURCE_DIR/..."|| failed=1
   echo "   🍏 ${PLUGIN}-darwin-amd64"
-  GOOS=darwin GOARCH=amd64 go build -ldflags "${ld_flags}" -o ./${PLUGIN}-darwin-amd64 "./$MAIN_SOURCE_DIR/..." || failed=1
+  GOOS=darwin GOARCH=amd64 go build -mod=vendor -ldflags "${ld_flags}" -o ./${PLUGIN}-darwin-amd64 "./$MAIN_SOURCE_DIR/..." || failed=1
   echo "   🎠 ${PLUGIN}-windows-amd64.exe"
-  GOOS=windows GOARCH=amd64 go build -ldflags "${ld_flags}" -o ./${PLUGIN}-windows-amd64.exe "./$MAIN_SOURCE_DIR/..." || failed=1
-  echo "   Z  ${PLUGIN}-linux-s390x"
-  GOOS=linux GOARCH=s390x go build -mod=vendor -ldflags "${ld_flags}" -o ./${PLUGIN}-linux-s390x ./cmd/... || failed=1
-  echo "   P  ${PLUGIN}-linux-ppc64le"
-  GOOS=linux GOARCH=ppc64le go build -mod=vendor -ldflags "${ld_flags}" -o ./${PLUGIN}-linux-ppc64le ./cmd/... || failed=1
+  GOOS=windows GOARCH=amd64 go build -mod=vendor -ldflags "${ld_flags}" -o ./${PLUGIN}-windows-amd64.exe "./$MAIN_SOURCE_DIR/..." || failed=1
+
   return ${failed}
 }
 
@@ -334,9 +349,6 @@ if $(has_flag --debug); then
     set -x
 fi
 
-# Global variables
-source $(basedir)/hack/global_vars.sh
-
 # Shared funcs with CI
 source $(basedir)/hack/build-flags.sh
 

hack/build.sh

@@ -14,13 +14,12 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+# Documentation about this script and how to use it can be found
+# at https://github.com/knative/hack
 
-# Documentation about how the functions here are hooked into the release process
-# and how to use it can be found at https://github.com/knative/hack
+source $(dirname $0)/../vendor/knative.dev/hack/release.sh
 
-source $(dirname "$0")/global_vars.sh
-source $(dirname "$0")/../vendor/knative.dev/hack/release.sh
-source $(dirname $0)/build-flags.sh
+PLUGIN="kn-quickstart"
 
 function build_release() {
   export GO111MODULE=on

hack/global_vars.sh

@@ -1,14 +1,12 @@
+//go:build tools
 // +build tools
 
 /*
 Copyright 2021 The Knative 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.
@@ -18,4 +16,7 @@ limitations under the License.
 
 package tools
 
-import _ "knative.dev/hack"
+// This package imports things required by this repository, to force `go mod` to see them as dependencies
+import (
+	_ "knative.dev/hack"
+)