Merge pull request #77 from mnottale/metadata-maintainers

metadata: Replace author by maintainers. Adapt.

Author: mat007

e2e/render/envvariables.dockerapp/metadata.yml

@@ -1,7 +1,9 @@
 version: 0.1.0
 name: myapp
 description: ""
-author: bearclaw
+maintainers:
+  - name: bearclaw
+    email: [email protected]
 targets:
   swarm: true
   kubernetes: true

e2e/render/templates.dockerapp/metadata.yml

@@ -1,7 +1,9 @@
 version: 0.1.0
 name: myapp
 description: ""
-author: bearclaw
+maintainers:
+  - name: bearclaw
+    email: [email protected]
 targets:
   swarm: true
   kubernetes: true

examples/simple/README.md

@@ -136,13 +136,22 @@ services:
 
 ```yaml
 # docker-app inspect simple
-version: 0.1.0
-name: simple
-description: ""
-author: sakuya.izayoi
-targets:
-  swarm: true
-  kubernetes: true
+simple 0.1.0
+Maintained by: sakuya.izayoi <[email protected]>
+
+
+
+Setting                  Default
+-------                  -------
+mysql.user.password      wordpress
+mysql.rootpass           axx[<^cz3d.fPb
+mysql.database           wordpressdata
+mysql.user.name          wordpress
+volumes.db_data.name     db_data
+debug                    true
+mysql.image.version      8
+wordpress.scale.mode     global
+wordpress.scale.replicas 0
 ```
 
 ### Generate helm package

examples/simple/simple.dockerapp/metadata.yml

@@ -1,8 +1,9 @@
 version: 0.1.0
-application:
-  name: simple
-  description: ""
-  author: sakuya.izayoi
+name: simple
+description: ""
+maintainers:
+  - name: sakuya.izayoi
+    email: [email protected]
 targets:
   swarm: true
   kubernetes: true

packager/init.go

@@ -217,9 +217,9 @@ func newMetadata(name string) types.AppMetadata {
 		userName = userData.Username
 	}
 	return types.AppMetadata{
-		Version: "0.1.0",
-		Targets: target,
-		Name:    name,
-		Author:  userName,
+		Version:     "0.1.0",
+		Targets:     target,
+		Name:        name,
+		Maintainers: []types.Maintainer{{Name: userName}},
 	}
 }

renderer/helm.go

@@ -27,12 +27,17 @@ type helmMeta struct {
 }
 
 func toHelmMeta(meta *types.AppMetadata) (*helmMeta, error) {
-	return &helmMeta{
+	res := &helmMeta{
 		Name:        meta.Name,
 		Version:     meta.Version,
 		Description: meta.Description,
-		Maintainers: []helmMaintainer{{Name: meta.Author}},
-	}, nil
+	}
+	for _, m := range meta.Maintainers {
+		res.Maintainers = append(res.Maintainers,
+			helmMaintainer{Name: m.Name + " <" + m.Email + ">"},
+		)
+	}
+	return res, nil
 }
 
 // Helm renders an app as an Helm Chart

renderer/inspect.go

@@ -5,6 +5,7 @@ import (
 	"io/ioutil"
 	"os"
 	"path/filepath"
+	"strings"
 	"text/tabwriter"
 
 	"github.com/docker/lunchbox/packager"
@@ -39,8 +40,14 @@ func Inspect(appname string) error {
 	if err != nil {
 		return err
 	}
+	// build maintainers string
+	maintainers := ""
+	for _, m := range meta.Maintainers {
+		maintainers += m.Name + " <" + m.Email + ">, "
+	}
+	maintainers = strings.TrimSuffix(maintainers, ", ")
 	fmt.Printf("%s %s\n", meta.Name, meta.Version)
-	fmt.Printf("Maintained by: %s\n", meta.Author)
+	fmt.Printf("Maintained by: %s\n", maintainers)
 	fmt.Println("")
 	fmt.Printf("%s\n", meta.Description)
 	fmt.Println("")

types/metadata.go

@@ -1,11 +1,17 @@
 package types
 
+// Maintainer represents one of the apps's maintainers
+type Maintainer struct {
+	Name  string
+	Email string
+}
+
 // AppMetadata is the format of the data found inside the metadata.yml file
 type AppMetadata struct {
 	Version     string
 	Name        string
 	Description string
-	Author      string
+	Maintainers []Maintainer
 	Targets     ApplicationTarget
 }