Improve kustomize version output #4630

KnVerey · 2022-05-10T00:00:22Z

Take advantage of go1.18's BuildInfo, when available, with fallback on the constants set by ldflags we use today. Should fix kustomize version output incomplete when building from source #4617.
Add json and yaml output formats.
Deprecate the Go struct output that is currently the default, to be replaced with a simple semver string. kubectl is doing the same: Start deprecating long/golang version information kubernetes/kubernetes#108987
Change the short output from a Go struct with whitespace errors to a simple semver string, to match kubectl.
Add more of the build info kubectl version offers, when available from BuildInfo: goVersion, gitTreeState

🚨 TODO: verify that the information will really be correct on a tagged commit, and in the goreleaser context. Most of the information isn't populated in tests: golang/go#33976. Everything looks good on make kustomize (which does go install), but the version is (devel) so not good confirmation.

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
{Version:(devel) GitCommit:2a0d821bdba197bf70c3883f79b9fad049e84854 GitTreeState:clean BuildDate:2022-05-09T23:45:42Z GoOs:darwin GoArch:arm64 GoVersion:go1.18.1}

> kustomize version --short
Flag --short has been deprecated, and will be removed in the future. The --short output will become the default.
(devel)

> kustomize version -o yaml
version: (devel)
gitCommit: 2a0d821bdba197bf70c3883f79b9fad049e84854
gitTreeState: clean
buildDate: "2022-05-09T23:45:42Z"
goOs: darwin
goArch: arm64
goVersion: go1.18.1

> kustomize version -o json
{
  "version": "(devel)",
  "gitCommit": "67e0a9a2c602a940247cdde08f77b7fb1d5cf8a5",
  "gitTreeState": "clean",
  "buildDate": "2022-05-09T23:57:55Z",
  "goOs": "darwin",
  "goArch": "arm64",
  "goVersion": "go1.18.1"
}

k8s-ci-robot · 2022-05-10T00:00:23Z

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

k8s-ci-robot · 2022-05-10T00:00:31Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: KnVerey

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~~ [KnVerey]

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

KnVerey · 2022-05-10T00:01:49Z

/hold on verifying release behaviour will be correct

k8s-ci-robot · 2022-05-10T00:08:32Z

@KnVerey: 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.

k8s-triage-robot · 2022-08-08T23:48:29Z

The Kubernetes project currently lacks enough contributors to adequately respond to all issues and PRs.

This bot triages issues and PRs according to the following rules:

After 90d of inactivity, lifecycle/stale is applied
After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

Mark this issue or PR as fresh with /remove-lifecycle stale
Mark this issue or PR as rotten with /lifecycle rotten
Close this issue or PR with /close
Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

k8s-triage-robot · 2022-11-24T21:13:02Z

The Kubernetes project currently lacks enough contributors to adequately respond to all issues and PRs.

This bot triages issues and PRs according to the following rules:

After 90d of inactivity, lifecycle/stale is applied
After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

Mark this issue or PR as fresh with /remove-lifecycle stale
Mark this issue or PR as rotten with /lifecycle rotten
Close this issue or PR with /close
Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

k8s-triage-robot · 2022-12-26T00:14:23Z

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs.

This bot triages issues and PRs according to the following rules:

After 90d of inactivity, lifecycle/stale is applied
After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

Mark this issue or PR as fresh with /remove-lifecycle rotten
Close this issue or PR with /close
Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle rotten

KnVerey · 2023-01-09T20:46:11Z

api/provenance/provenance.go

+		switch setting.Key {
+		case "vcs.revision":
+			p.GitCommit = setting.Value
+		case "vcs.modified":


We never had this before and it wasn't working properly in the release, so 🔥 for now

KnVerey · 2023-01-09T20:54:28Z

api/provenance/provenance.go

+			case "false":
+				p.GitTreeState = "clean"
+			}
+		case "vcs.time": // TODO: This is the commit time, not the build time.


🔥 this change as well. The build date used by kubectl really is the build date, not the commit date. I think it comes from here, ultimately: https://github.com/kubernetes/kubernetes/blob/f33ddd1b9c1f53ca9bb7dd8a55c7e15ced1292a8/hack/lib/version.sh#L168

KnVerey · 2023-01-09T20:59:22Z

releasing/run-goreleaser.sh

@@ -100,9 +100,6 @@ builds:

  ldflags: >
    -s
-    -X sigs.k8s.io/kustomize/api/provenance.version={{.Version}}
-    -X sigs.k8s.io/kustomize/api/provenance.gitCommit={{.Commit}}
-    -X sigs.k8s.io/kustomize/api/provenance.buildDate={{.Date}}


We at least do need to keep the date flag. Based on the notes I left on this PR, it seems possible the others always work from the BuildInfo source, in which case we can keep them deleted (but we need to confirm). Perhaps we can add any that we're keeping to the Makefile so that local builds are more sane anyway.

KnVerey · 2023-02-01T00:17:15Z

Closing in favour of #5000

k8s-ci-robot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels May 10, 2022

k8s-ci-robot requested review from natasha41575 and yuwenma May 10, 2022 00:00

k8s-ci-robot added approved Indicates a PR has been approved by an approver from all required OWNERS files. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels May 10, 2022

k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label May 10, 2022

KnVerey force-pushed the buildinfo_provenance branch from 316cd16 to 1089b67 Compare May 10, 2022 00:31

KnVerey mentioned this pull request May 10, 2022

kustomize version output incomplete when building from source #4617

Closed

KnVerey force-pushed the buildinfo_provenance branch from c604e48 to 3c91cf7 Compare May 10, 2022 22:06

k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Aug 8, 2022

KnVerey force-pushed the buildinfo_provenance branch from b54821f to 6d64657 Compare August 10, 2022 18:18

KnVerey removed the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Aug 10, 2022

k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Aug 26, 2022

k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Nov 24, 2022

KnVerey added 3 commits November 25, 2022 19:03

Use BuildInfo for version output, add yaml|json formats

0b3ee1a

Remove ldflags fallback

5ff2337

add todos

cca7bfa

KnVerey force-pushed the buildinfo_provenance branch from 6d64657 to cca7bfa Compare November 26, 2022 00:07

k8s-ci-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Nov 26, 2022

k8s-ci-robot added lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. and removed lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. labels Dec 26, 2022

KnVerey commented Jan 9, 2023

View reviewed changes

cailynse mentioned this pull request Jan 12, 2023

WIP: Improve version output 2617 #4976

Closed

cailynse mentioned this pull request Jan 25, 2023

Update Versioning to Improve Output #5000

Merged

KnVerey closed this Feb 1, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Improve kustomize version output #4630

Improve kustomize version output #4630

KnVerey commented May 10, 2022 •

edited

k8s-ci-robot commented May 10, 2022

k8s-ci-robot commented May 10, 2022

KnVerey commented May 10, 2022

k8s-ci-robot commented May 10, 2022

k8s-triage-robot commented Aug 8, 2022

k8s-triage-robot commented Nov 24, 2022

k8s-triage-robot commented Dec 26, 2022

KnVerey Jan 9, 2023

KnVerey Jan 9, 2023

KnVerey Jan 9, 2023

KnVerey commented Feb 1, 2023

Improve kustomize version output #4630

Improve kustomize version output #4630

Conversation

KnVerey commented May 10, 2022 • edited

Local build before

Local build after

k8s-ci-robot commented May 10, 2022

k8s-ci-robot commented May 10, 2022

KnVerey commented May 10, 2022

k8s-ci-robot commented May 10, 2022

k8s-triage-robot commented Aug 8, 2022

k8s-triage-robot commented Nov 24, 2022

k8s-triage-robot commented Dec 26, 2022

KnVerey Jan 9, 2023

Choose a reason for hiding this comment

KnVerey Jan 9, 2023

Choose a reason for hiding this comment

KnVerey Jan 9, 2023

Choose a reason for hiding this comment

KnVerey commented Feb 1, 2023

KnVerey commented May 10, 2022 •

edited