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

     1  /*
     2  Copyright 2018 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 = &GitIgnore{}
    24  
    25  // GitIgnore scaffolds a file that defines which files should be ignored by git
    26  type GitIgnore struct {
    27  	machinery.TemplateMixin
    28  }
    29  
    30  // SetTemplateDefaults implements file.Template
    31  func (f *GitIgnore) SetTemplateDefaults() error {
    32  	if f.Path == "" {
    33  		f.Path = ".gitignore"
    34  	}
    35  
    36  	f.TemplateBody = gitignoreTemplate
    37  
    38  	return nil
    39  }
    40  
    41  const gitignoreTemplate = `
    42  # Binaries for programs and plugins
    43  *.exe
    44  *.exe~
    45  *.dll
    46  *.so
    47  *.dylib
    48  bin
    49  
    50  # Test binary, build with ` + "`go test -c`" + `
    51  *.test
    52  
    53  # Output of the go coverage tool, specifically when used with LiteIDE
    54  *.out
    55  
    56  # Kubernetes Generated files - skip generated files, except for vendored files
    57  
    58  !vendor/**/zz_generated.*
    59  
    60  # editor and IDE paraphernalia
    61  .idea
    62  .vscode
    63  *.swp
    64  *.swo
    65  *~
    66  `