Skip to content

Commit

Permalink
git: fix reference json serialization
Browse files Browse the repository at this point in the history
- add omitempty to GitRepositoryRef fields
  • Loading branch information
stefanprodan committed Apr 30, 2020
1 parent f2bff90 commit c9db552
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 17 deletions.
14 changes: 6 additions & 8 deletions api/v1alpha1/gitrepository_types.go
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,7 @@ type GitRepositorySpec struct {
// +required
Interval metav1.Duration `json:"interval"`

// The timeout for remote git operations like cloning.
// +kubebuilder:validation:Default=20s
// The timeout for remote git operations like cloning, default to 20s.
// +optional
Timeout *metav1.Duration `json:"timeout,omitempty"`

Expand All @@ -61,20 +60,19 @@ type GitRepositorySpec struct {
type GitRepositoryRef struct {
// The git branch to checkout, defaults to master.
// +optional
Branch string `json:"branch"`
Branch string `json:"branch,omitempty"`

// The git tag to checkout, takes precedence over branch.
// +optional
Tag string `json:"tag"`
Tag string `json:"tag,omitempty"`

// The git tag semver expression, takes precedence over tag.
// +optional
SemVer string `json:"semver"`
SemVer string `json:"semver,omitempty"`

// The git commit sha to checkout, if specified tag filters will be
// ignored.
// The git commit sha to checkout, if specified tag filters will be ignored.
// +optional
Commit string `json:"commit"`
Commit string `json:"commit,omitempty"`
}

// GitRepositoryVerification defines the OpenPGP signature verification process.
Expand Down
3 changes: 2 additions & 1 deletion config/crd/bases/source.fluxcd.io_gitrepositories.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,8 @@ spec:
type: string
type: object
timeout:
description: The timeout for remote git operations like cloning.
description: The timeout for remote git operations like cloning, default
to 20s.
type: string
url:
description: The repository URL, can be a HTTP or SSH address.
Expand Down
14 changes: 6 additions & 8 deletions docs/spec/v1alpha1/gitrepositories.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,7 @@ type GitRepositorySpec struct {
// The interval at which to check for repository updates.
Interval metav1.Duration `json:"interval"`

// The timeout for remote git operations like cloning.
// +kubebuilder:validation:Default=20s
// The timeout for remote git operations like cloning, default to 20s.
// +optional
Timeout *metav1.Duration `json:"timeout,omitempty"`

Expand All @@ -50,20 +49,19 @@ Git repository reference:
type GitRepositoryRef struct {
// The git branch to checkout, defaults to master.
// +optional
Branch string `json:"branch"`
Branch string `json:"branch,omitempty"`

// The git tag to checkout, takes precedence over branch.
// +optional
Tag string `json:"tag"`
Tag string `json:"tag,omitempty"`

// The git tag semver expression, takes precedence over tag.
// +optional
SemVer string `json:"semver"`
SemVer string `json:"semver,omitempty"`

// The git commit sha to checkout, if specified branch and tag filters will
// ignored.
// The git commit sha to checkout, if specified tag filters will be ignored.
// +optional
Commit string `json:"commit"`
Commit string `json:"commit,omitempty"`
}
```

Expand Down

0 comments on commit c9db552

Please sign in to comment.