airshipctl/pkg/util/yaml/writer.go
Yasin, Siraj (SY495P) c25d223c7b Add copyright for missing files
* added license templates for go, bash & yaml in tools dir
* added a script that will add license information for all
    missing files. Type:  go, yaml, yml, sh
* skip adding license for all files within testdata
* Syntax:
   > ./tools/add_license.sh

* Skip license for manifests folder
* Added one extra line after licene for yaml files
* Added License after Hashbang for bash.
* Add an extra line after hashbang and before license
* Updated the go template to use multiline comments

New Files:
  1. tools/add_license.sh
  2. tools/license_go.txt
  3. tools/license_yaml.txt
  4. tools/license_bash.txt

Change-Id: Ia4da5b261e7cd518d446896b72c810421877472a
Realtes-To:#147
2020-04-09 08:35:59 -05:00

53 lines
1.3 KiB
Go

/*
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
https://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package yaml
import (
"io"
"sigs.k8s.io/yaml"
)
const (
// DotYamlSeparator yaml separator
DotYamlSeparator = "...\n"
// DashYamlSeparator yaml separator
DashYamlSeparator = "---\n"
)
// WriteOut dumps any yaml compatible document to writer, adding yaml separator `---`
// at the beginning of the document, and `...` at the end
func WriteOut(dst io.Writer, src interface{}) error {
yamlOut, err := yaml.Marshal(src)
if err != nil {
return err
}
// add separator for each document
_, err = dst.Write([]byte(DashYamlSeparator))
if err != nil {
return err
}
_, err = dst.Write(yamlOut)
if err != nil {
return err
}
// add separator for each document
_, err = dst.Write([]byte(DotYamlSeparator))
if err != nil {
return err
}
return nil
}