sigs.k8s.io/kubebuilder/v3@v3.14.0/pkg/plugins/golang/v2/scaffolds/internal/templates/gomod.go (about)

     1  /*
     2  Copyright 2019 The Kubernetes Authors.
     3  
     4  Licensed under the Apache License, Version 2.0 (the "License");
     5  you may not use this file except in compliance with the License.
     6  You may obtain a copy of the License at
     7  
     8      http://www.apache.org/licenses/LICENSE-2.0
     9  
    10  Unless required by applicable law or agreed to in writing, software
    11  distributed under the License is distributed on an "AS IS" BASIS,
    12  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    13  See the License for the specific language governing permissions and
    14  limitations under the License.
    15  */
    16  
    17  package templates
    18  
    19  import (
    20  	"sigs.k8s.io/kubebuilder/v3/pkg/machinery"
    21  )
    22  
    23  var _ machinery.Template = &GoMod{}
    24  
    25  // GoMod scaffolds a file that defines the project dependencies
    26  type GoMod struct {
    27  	machinery.TemplateMixin
    28  	machinery.RepositoryMixin
    29  
    30  	ControllerRuntimeVersion string
    31  }
    32  
    33  // SetTemplateDefaults implements file.Template
    34  func (f *GoMod) SetTemplateDefaults() error {
    35  	if f.Path == "" {
    36  		f.Path = "go.mod"
    37  	}
    38  
    39  	f.TemplateBody = goModTemplate
    40  
    41  	f.IfExistsAction = machinery.OverwriteFile
    42  
    43  	return nil
    44  }
    45  
    46  const goModTemplate = `
    47  module {{ .Repo }}
    48  
    49  go 1.13
    50  
    51  require (
    52  	sigs.k8s.io/controller-runtime {{ .ControllerRuntimeVersion }}
    53  )
    54  `