Merge branch 'master' into master

Author: dirtycajunrice

docs/helm_annotations.md

@@ -0,0 +1,38 @@
+# Artifact Hub annotations in Helm Chart.yaml file
+
+Artifact Hub uses the metadata in the chart's `Chart.yaml` file to populate the information for a package of kind Helm. Usually most of the information needed is already there, so there is no extra work required by charts maintainers to list them on Artifact Hub.
+
+However, sometimes there might be cases in which it may be useful to provide some more context that helps improving users' experience in Artifact Hub. This can be done using some special **annotations** in the [Chart.yaml](https://helm.sh/docs/topics/charts/#the-chartyaml-file) file.
+
+## Supported annotations
+
+- **artifacthub.io/operator** *(boolean)*
+
+Use this annotation to indicate that your chart represents an operator. Artifact Hub at the moment also considers your chart to represent an operator if the word *operator* appears in the chart name.
+
+- **artifacthub.io/links** *(yaml string, see example below)*
+
+This annotation allows including named links, which will be rendered nicely in Artifact Hub. You can use this annotation to include links not included previously in the Chart.yaml file, or you can use it to name links already present (in the sources section, for example).
+
+- **artifacthub.io/maintainers** *(yaml string, see example below)*
+
+This annotation can be used if you want to display a different name for a given user in Artifact Hub than the one used in the Chart.yaml file. If the email used matches, the name used in the annotations entry will be displayed in Artifact Hub. It's also possible to include maintainers that should only be listed in Artifact Hub by adding additional entries.
+
+## Example
+
+Artifact Hub annotations in`Chart.yaml`:
+
+```yaml
+annotations:
+  "artifacthub.io/operator": true
+  "artifacthub.io/links": |
+    - name: link1
+      url: https://link1.url
+    - name: link2
+      url: https://link2.url
+  "artifacthub.io/maintainers": |
+    - name: user1
+      email: user1@email.com
+    - name: user2
+      email: user2@email.com
+```

internal/tracker/helm/testdata/pkg1-1.0.0.tgz

@@ -9,6 +9,7 @@ import (
 	"net/url"
 	"path"
 	"runtime/debug"
+	"strconv"
 	"strings"
 	"sync"
 
@@ -19,10 +20,17 @@ import (
 	"github.com/rs/zerolog/log"
 	"github.com/vincent-petithory/dataurl"
 	"golang.org/x/time/rate"
+	"gopkg.in/yaml.v2"
 	"helm.sh/helm/v3/pkg/chart"
 	"helm.sh/helm/v3/pkg/chart/loader"
 )
 
+const (
+	operatorAnnotation    = "artifacthub.io/operator"
+	linksAnnotation       = "artifacthub.io/links"
+	maintainersAnnotation = "artifacthub.io/maintainers"
+)
+
 // githubRL represents a rate limiter used when loading charts from Github, to
 // avoid some rate limiting issues were are experiencing.
 var githubRL = rate.NewLimiter(2, 1)
@@ -195,6 +203,11 @@ func (w *Worker) handleRegisterJob(j *Job) {
 		}
 	}
 
+	// Enrich package with information from annotations
+	if err := enrichPackageFromAnnotations(p, md.Annotations); err != nil {
+		w.warn(name, version, fmt.Errorf("error enriching package: %w", err))
+	}
+
 	// Register package
 	w.logger.Debug().Str("name", md.Name).Str("v", md.Version).Msg("registering package")
 	if err := w.svc.Pm.Register(w.svc.Ctx, p); err != nil {
@@ -297,3 +310,76 @@ func getFile(chart *chart.Chart, name string) *chart.File {
 	}
 	return nil
 }
+
+// enrichPackageFromAnnotations adds some extra information to the package from
+// the provided annotations.
+//
+// The annotations supported at the moment are:
+//
+// - artifacthub.io/operator
+// - artifacthub.io/links
+// - artifacthub.io/maintainers
+//
+// Example:
+//
+// annotations:
+//   "artifacthub.io/operator": true
+//   "artifacthub.io/links": |
+//     - name: link1
+//       url: https://link1.url
+//     - name: link2
+//       url: https://link2.url
+//   "artifacthub.io/maintainers": |
+//     - name: user1
+//       email: user1@email.com
+//     - name: user2
+//       email: user2@email.com
+//
+func enrichPackageFromAnnotations(p *hub.Package, annotations map[string]string) error {
+	// Operator flag
+	if v, ok := annotations[operatorAnnotation]; ok {
+		isOperator, err := strconv.ParseBool(v)
+		if err != nil {
+			return errors.New("invalid operator value")
+		}
+		p.IsOperator = isOperator
+	}
+
+	// Links
+	if v, ok := annotations[linksAnnotation]; ok {
+		var links []*hub.Link
+		if err := yaml.Unmarshal([]byte(v), &links); err != nil {
+			return fmt.Errorf("invalid links value: %s", v)
+		}
+	LL:
+		for _, link := range links {
+			for _, pLink := range p.Links {
+				if link.URL == pLink.URL {
+					pLink.Name = link.Name
+					continue LL
+				}
+			}
+			p.Links = append(p.Links, link)
+		}
+	}
+
+	// Maintainers
+	if v, ok := annotations[maintainersAnnotation]; ok {
+		var maintainers []*hub.Maintainer
+		if err := yaml.Unmarshal([]byte(v), &maintainers); err != nil {
+			return fmt.Errorf("invalid maintainers value: %s", v)
+		}
+	ML:
+		for _, maintainer := range maintainers {
+			for _, pMaintainer := range p.Maintainers {
+				if maintainer.Email == pMaintainer.Email {
+					pMaintainer.Name = maintainer.Name
+					continue ML
+				}
+			}
+			p.Maintainers = append(p.Maintainers, maintainer)
+		}
+	}
+
+	return nil
+}