Clarify the revision's default value in the API (#1051)

GoogleContainerTools · Nov 20, 2023 · cb6d774 · cb6d774
1 parent 6c1140a
commit cb6d774
Show file tree

Hide file tree

Showing 4 changed files with 24 additions and 6 deletions.
diff --git a/manifests/reposync-crd.yaml b/manifests/reposync-crd.yaml
@@ -147,7 +147,10 @@ spec:
                     type: string
                   revision:
                     description: revision is the git revision (branch, tag, ref or
-                      commit) to fetch. Revision defaults to 'branch'.
+                      commit) to fetch. If 'revision' is not specified, it defaults
+                      to the HEAD of the branch that is specified in the 'branch'
+                      field. If neither 'revision' nor 'branch' is specified, it defaults
+                      to the HEAD of the 'master' branch.
                     type: string
                   secretRef:
                     description: secretRef is the secret used to connect to the Git
@@ -1191,7 +1194,10 @@ spec:
                     type: string
                   revision:
                     description: revision is the git revision (branch, tag, ref or
-                      commit) to fetch. Revision defaults to 'branch'.
+                      commit) to fetch. If 'revision' is not specified, it defaults
+                      to the HEAD of the branch that is specified in the 'branch'
+                      field. If neither 'revision' nor 'branch' is specified, it defaults
+                      to the HEAD of the 'master' branch.
                     type: string
                   secretRef:
                     description: secretRef is the secret used to connect to the Git

diff --git a/manifests/rootsync-crd.yaml b/manifests/rootsync-crd.yaml
@@ -147,7 +147,10 @@ spec:
                     type: string
                   revision:
                     description: revision is the git revision (branch, tag, ref or
-                      commit) to fetch. Revision defaults to 'branch'.
+                      commit) to fetch. If 'revision' is not specified, it defaults
+                      to the HEAD of the branch that is specified in the 'branch'
+                      field. If neither 'revision' nor 'branch' is specified, it defaults
+                      to the HEAD of the 'master' branch.
                     type: string
                   secretRef:
                     description: secretRef is the secret used to connect to the Git
@@ -1246,7 +1249,10 @@ spec:
                     type: string
                   revision:
                     description: revision is the git revision (branch, tag, ref or
-                      commit) to fetch. Revision defaults to 'branch'.
+                      commit) to fetch. If 'revision' is not specified, it defaults
+                      to the HEAD of the branch that is specified in the 'branch'
+                      field. If neither 'revision' nor 'branch' is specified, it defaults
+                      to the HEAD of the 'master' branch.
                     type: string
                   secretRef:
                     description: secretRef is the secret used to connect to the Git

diff --git a/pkg/api/configsync/v1alpha1/gitconfig.go b/pkg/api/configsync/v1alpha1/gitconfig.go
@@ -32,7 +32,10 @@ type Git struct {
 	Branch string `json:"branch,omitempty"`
 
 	// revision is the git revision (branch, tag, ref or commit) to fetch.
-	// Revision defaults to 'branch'.
+	// If 'revision' is not specified, it defaults to the HEAD of the branch that
+	// is specified in the 'branch' field.
+	// If neither 'revision' nor 'branch' is specified, it defaults to the HEAD of
+	// the 'master' branch.
 	// +optional
 	Revision string `json:"revision,omitempty"`
 

diff --git a/pkg/api/configsync/v1beta1/gitconfig.go b/pkg/api/configsync/v1beta1/gitconfig.go
@@ -32,7 +32,10 @@ type Git struct {
 	Branch string `json:"branch,omitempty"`
 
 	// revision is the git revision (branch, tag, ref or commit) to fetch.
-	// Revision defaults to 'branch'.
+	// If 'revision' is not specified, it defaults to the HEAD of the branch that
+	// is specified in the 'branch' field.
+	// If neither 'revision' nor 'branch' is specified, it defaults to the HEAD of
+	// the 'master' branch.
 	// +optional
 	Revision string `json:"revision,omitempty"`