Sort references (#2)

* Sort references * Move sorting to method call * Add build status
elastic · Feb 18, 2020 · bdc856d · bdc856d
1 parent 4fa7899
commit bdc856d
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1,3 +1,6 @@
+![](https://github.com/elastic/crd-ref-docs/workflows/Build/badge.svg)
+
+
 CRD Reference Documentation Generator
 ======================================
 

diff --git a/templates/asciidoctor/type.tpl b/templates/asciidoctor/type.tpl
@@ -10,7 +10,7 @@
 {{ if $type.References -}}
 .Appears In:
 ****
-{{- range $type.References }}
+{{- range $type.SortedReferences }}
 - {{ asciidocRenderTypeLink . }}
 {{- end }}
 ****

diff --git a/types/types.go b/types/types.go
@@ -174,6 +174,26 @@ func (t *Type) IsAlias() bool {
 	return t.Kind == AliasKind
 }
 
+func (t *Type) SortedReferences() []*Type {
+	if t == nil || len(t.References) == 0 {
+		return nil
+	}
+
+	sort.Slice(t.References, func(i, j int) bool {
+		if t.References[i].Name < t.References[j].Name {
+			return true
+		}
+
+		if t.References[i].Name == t.References[j].Name {
+			return t.References[i].Package < t.References[j].Package
+		}
+
+		return false
+	})
+
+	return t.References
+}
+
 // Field describes a field in a struct.
 type Field struct {
 	Name     string