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

     1  /*
     2  Copyright 2022 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 = &DockerIgnore{}
    24  
    25  // DockerIgnore scaffolds a file that defines which files should be ignored by the containerized build process
    26  type DockerIgnore struct {
    27  	machinery.TemplateMixin
    28  }
    29  
    30  // SetTemplateDefaults implements file.Template
    31  func (f *DockerIgnore) SetTemplateDefaults() error {
    32  	if f.Path == "" {
    33  		f.Path = ".dockerignore"
    34  	}
    35  
    36  	f.TemplateBody = dockerignorefileTemplate
    37  
    38  	return nil
    39  }
    40  
    41  const dockerignorefileTemplate = `# More info: https://docs.docker.com/engine/reference/builder/#dockerignore-file
    42  # Ignore build and test binaries.
    43  bin/
    44  `