Update Versioning to Improve Output

[cailynse]

Working from: #4630

[directly updated by Katrina Jan 31 because Cailyn is OOO]

• Take advantage of go1.18's BuildInfo as the source of the git commit version. Testing indicates this is reliably available.

  • Unlike the PR this picks up from, this no longer uses BuildInfo for anything else. There is some nuance to how the module version gets populated in BuildInfo, and in our testing, it was never actually set. Possibly related to runtime/debug: document BuildInfo.Main.Version == "(devel)" golang/go#29228. So, I do not think this addresses kustomize version output incomplete when building from source #4617 in the end; that will require subsequent investigation, but the other improvements are still worth merging.

• Continue to use ldflags for the build date and version data. Make sure the build date ldflag is set in our makefile.

• Add json and yaml output formats.

• Replace the Go struct dump with a simple semver string as the main version output. kubectl is doing the same: Start deprecating long/golang version information kubernetes/kubernetes#108987

• Deprecate the short output flag.

• Add go version from build info

Local Build Before

༶ kustomize version                                                                                                                           
{Version:unknown GitCommit:$Format:%H$ BuildDate:1970-01-01T00:00:00Z GoOs:darwin GoArch:arm64}

༶ kustomize version --short                                                                                                                 
{unknown  1970-01-01T00:00:00Z  }

Local Build After

༶ kustomize version                                                                                                                           
(devel)

༶ kustomize version --short                                                                                                                 
Flag --short has been deprecated, and will be removed in the future.
{(devel)  2023-02-01T19:02:33Z   }

༶ kustomize version -o yaml                                                                                                                    
version: (devel)
gitCommit: 681f21f05a0d3483ecf6fdadb83e4dd41f70b5c9
buildDate: "2023-02-01T19:02:33Z"
goOs: darwin
goArch: arm64
goVersion: go1.19.2

༶ kustomize version -o json                                                                                                             
{
  "version": "(devel)",
  "gitCommit": "681f21f05a0d3483ecf6fdadb83e4dd41f70b5c9",
  "buildDate": "2023-02-01T19:02:33Z",
  "goOs": "darwin",
  "goArch": "arm64",
  "goVersion": "go1.19.2"
}

[k8s-ci-robot]

Skipping CI for Draft Pull Request.
If you want CI signal for your change, please convert it to an actual PR.
You can still manually trigger a test run with /test all

[cailynse]

Should I also set the other ldflag fields with test values here?

[k8s-ci-robot]

This PR has multiple commits, and the default merge method is: merge.
You can request commits to be squashed using the label: tide/merge-method-squash

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

[KnVerey]

technically, this is already breaking. Alternatively, we could either leave it as is (and update the deprecation notice on the main format), or go ahead and remove it in v5 without deprecation. Wdyt @natasha41575 ?

[annasong20]

Will leave this to @natasha41575

[KnVerey]

Alternatively, we could be less conservative and replace it now with the major version bump.

[annasong20]

/label tide/merge-method-squash

[KnVerey]

/hold
I want to do a final test using the release tooling right before this merges

[annasong20]

/lgtm

[KnVerey]

Tested this against the releaser build process as follows.

1. Pin the kustomize module to the local copies of the dependent modules

diff --git a/kustomize/go.mod b/kustomize/go.mod
index e77d0d1db..84bb99c2c 100644
--- a/kustomize/go.mod
+++ b/kustomize/go.mod
@@ -14,6 +14,10 @@ require (
        sigs.k8s.io/yaml v1.3.0
 )

+replace sigs.k8s.io/kustomize/api => ../api
+replace sigs.k8s.io/kustomize/cmd/config => ../cmd/config
+replace sigs.k8s.io/kustomize/kyaml => ../kyaml
+

2. Disable the changelog script

diff --git a/releasing/compile-changelog.sh b/releasing/compile-changelog.sh
index ce7293c0c..bc0c4931c 100755
--- a/releasing/compile-changelog.sh
+++ b/releasing/compile-changelog.sh
@@ -31,6 +31,8 @@ module=$1
 fullTag=$2
 changeLogFile="${3:-}"

+exit 0
+
 # Find previous tag that matches the tags module
 allTags=$(git tag -l "$module*" --sort=-version:refname --no-contains="$fullTag")
 prevTag=$(echo "$allTags" | head -n 1)

3. Run releasing/run-goreleaser.sh kustomize/v4.5.7 build --snapshot

4. Test the resulting binary, i.e. ./kustomize/dist/kustomize_darwin_arm64/kustomize on my machine

Results

༶ ./kustomize/dist/kustomize_darwin_arm64/kustomize version
v4.5.7-SNAPSHOT-8a84ec72b

༶ ./kustomize/dist/kustomize_darwin_arm64/kustomize version --short                                                                                                                                                                                                                                      
Flag --short has been deprecated, and will be removed in the future.
{kustomize/v4.5.7-SNAPSHOT-8a84ec72b  2023-02-01T19:21:32Z   }

༶ ./kustomize/dist/kustomize_darwin_arm64/kustomize version -o yaml                                                                                                                                                                                                                                     
version: kustomize/v4.5.7-SNAPSHOT-8a84ec72b
gitCommit: 8a84ec72b75d92bc157b3fa79a612b72d38f72b8
buildDate: "2023-02-01T19:21:32Z"
goOs: darwin
goArch: arm64
goVersion: go1.19.2

༶ ./kustomize/dist/kustomize_darwin_arm64/kustomize version -o json                                                                                                                                                                                                                                     
{
  "version": "kustomize/v4.5.7-SNAPSHOT-8a84ec72b",
  "gitCommit": "8a84ec72b75d92bc157b3fa79a612b72d38f72b8",
  "buildDate": "2023-02-01T19:21:32Z",
  "goOs": "darwin",
  "goArch": "arm64",
  "goVersion": "go1.19.2"
}

[KnVerey]

/unhold

[k8s-ci-robot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: annasong20, cailynse, natasha41575

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

• OWNERS [natasha41575]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[natasha41575]

/lgtm