Merge pull request #23 from roots/add-yaml-comment-headers

Add Yaml comment headers to configs

cmd/new.go

@@ -19,20 +19,21 @@ import (
 )
 
 type NewCommand struct {
-	UI        cli.Ui
-	flags     *flag.FlagSet
-	trellis   *trellis.Trellis
-	force     bool
-	vaultPass string
+	UI         cli.Ui
+	CliVersion string
+	flags      *flag.FlagSet
+	trellis    *trellis.Trellis
+	force      bool
+	vaultPass  string
 }
 
 type Release struct {
 	Version string `json:"tag_name"`
 	ZipUrl  string `json:"zipball_url"`
 }
 
-func NewNewCommand(ui cli.Ui, trellis *trellis.Trellis) *NewCommand {
-	c := &NewCommand{UI: ui, trellis: trellis}
+func NewNewCommand(ui cli.Ui, trellis *trellis.Trellis, version string) *NewCommand {
+	c := &NewCommand{UI: ui, trellis: trellis, CliVersion: version}
 	c.init()
 	return c
 }
@@ -120,11 +121,19 @@ func (c *NewCommand) Run(args []string) int {
 	// Update default configs
 	for env, config := range c.trellis.Environments {
 		c.trellis.UpdateDefaultConfig(config, name, host, env)
-		c.trellis.WriteConfigYaml(config, filepath.Join("group_vars", env, "wordpress_sites.yml"))
+		c.trellis.WriteYamlFile(
+			config,
+			filepath.Join("group_vars", env, "wordpress_sites.yml"),
+			c.YamlHeader("https://roots.io/trellis/docs/wordpress-sites/"),
+		)
 
 		stringGenerator := trellis.RandomStringGenerator{Length: 64}
 		vault := c.trellis.GenerateVaultConfig(name, env, &stringGenerator)
-		c.trellis.WriteVaultYaml(vault, filepath.Join("group_vars", env, "vault.yml"))
+		c.trellis.WriteYamlFile(
+			vault,
+			filepath.Join("group_vars", env, "vault.yml"),
+			c.YamlHeader("https://roots.io/trellis/docs/vault/"),
+		)
 	}
 
 	if err := c.trellis.GenerateVaultPassFile(c.vaultPass); err != nil {
@@ -181,6 +190,12 @@ Options:
 	return strings.TrimSpace(helpText)
 }
 
+func (c *NewCommand) YamlHeader(doc string) string {
+	const header = "# Created by trellis-cli v%s\n# Documentation: %s\n\n"
+
+	return fmt.Sprintf(header, c.CliVersion, doc)
+}
+
 func addTrellisFile(path string) error {
 	path = filepath.Join(path, ".trellis.yml")
 	return ioutil.WriteFile(path, []byte{}, 0666)

main.go

@@ -9,7 +9,7 @@ import (
 )
 
 func main() {
-	c := cli.NewCLI("trellis", "0.1.0")
+	c := cli.NewCLI("trellis", "0.2.1")
 	c.Args = os.Args[1:]
 
 	ui := &cli.ColoredUi{
@@ -38,7 +38,7 @@ func main() {
 			return &cmd.InfoCommand{UI: ui, Trellis: trellis}, nil
 		},
 		"new": func() (cli.Command, error) {
-			return cmd.NewNewCommand(ui, trellis), nil
+			return cmd.NewNewCommand(ui, trellis, c.Version), nil
 		},
 		"provision": func() (cli.Command, error) {
 			return cmd.NewProvisionCommand(ui, trellis), nil

trellis/config.go

@@ -82,13 +82,3 @@ func (t *Trellis) UpdateDefaultConfig(config *Config, name string, host string,
 	delete(config.WordPressSites, DefaultSiteName)
 	t.GenerateSite(config.WordPressSites[name], name, host, env)
 }
-
-func (t *Trellis) WriteConfigYaml(config *Config, path string) error {
-	configYaml, err := yaml.Marshal(config)
-
-	if err != nil {
-		log.Fatal(err)
-	}
-
-	return t.WriteYamlFile(path, configYaml)
-}

trellis/trellis.go

@@ -3,6 +3,7 @@ package trellis
 import (
 	"errors"
 	"gopkg.in/ini.v1"
+	"gopkg.in/yaml.v2"
 	"io/ioutil"
 	"log"
 	"os"
@@ -109,8 +110,14 @@ func (t *Trellis) UpdateAnsibleConfig(section string, key string, value string)
 	return nil
 }
 
-func (t *Trellis) WriteYamlFile(path string, data []byte) error {
+func (t *Trellis) WriteYamlFile(s interface{}, path string, header string) error {
+	data, err := yaml.Marshal(s)
+	if err != nil {
+		log.Fatal(err)
+	}
+
 	path = filepath.Join(t.Path, path)
+	data = append([]byte(header), data...)
 
 	if err := ioutil.WriteFile(path, data, 0666); err != nil {
 		log.Fatal(err)

trellis/vault.go

@@ -3,7 +3,6 @@ package trellis
 import (
 	"crypto/rand"
 	"fmt"
-	"gopkg.in/yaml.v2"
 	"io"
 	"io/ioutil"
 	"log"
@@ -98,16 +97,6 @@ func (t *Trellis) GenerateVaultPassFile(path string) error {
 	return ioutil.WriteFile(path, []byte(vaultPass), 0600)
 }
 
-func (t *Trellis) WriteVaultYaml(vault *Vault, path string) error {
-	vaultYaml, err := yaml.Marshal(vault)
-
-	if err != nil {
-		log.Fatal(err)
-	}
-
-	return t.WriteYamlFile(path, vaultYaml)
-}
-
 func assertAvailablePRNG() {
 	buf := make([]byte, 1)