Make generated docs Table of Contents deterministic.

Author: pwittrock

cmd/kubebuilder/docs/gen.go

@@ -2,14 +2,14 @@ package docs
 
 import (
 	"fmt"
+	"os"
 	"path/filepath"
 	"sort"
 	"strings"
 
 	"github.com/kubernetes-sigs/kubebuilder/cmd/internal/codegen/parse"
 	"github.com/kubernetes-sigs/kubebuilder/cmd/kubebuilder/util"
 	"k8s.io/gengo/args"
-	"os"
 )
 
 // CodeGenerator generates code for Kubernetes resources and controllers
@@ -36,7 +36,13 @@ func (g CodeGenerator) Execute(dir string) error {
 	path := filepath.Join(dir, outputDir, "config.yaml")
 
 	args := ConfigArgs{}
-	for group, kindversion := range p.ByGroupKindVersion {
+	groups := []string{}
+	for group, _ := range p.ByGroupKindVersion {
+		groups = append(groups, group)
+	}
+	sort.Strings(groups)
+	for _, group := range groups {
+		kindversion := p.ByGroupKindVersion[group]
 		args.Groups = append(args.Groups, strings.Title(group))
 		c := Category{
 			Name:    strings.Title(group),

test/docs/expected/config.yaml

@@ -1,7 +1,16 @@
 example_location: "examples"
 api_groups: 
+  - "Ant"
+
   - "Insect"
 resource_categories: 
+- name: "Ant"
+  include: "ant"
+  resources: 
+  - name: "Ant"
+    version: "v1beta1"
+    group: "ant"
+
 - name: "Insect"
   include: "insect"
   resources: 

test/docs/expected/includes/_ant.md

@@ -0,0 +1,5 @@
+
+# <strong>Ant</strong>
+
+------------
+

test/docs/expected/includes/_generated_ant_v1beta1_ant_concept.md

@@ -0,0 +1,58 @@
+
+
+-----------
+# Ant v1beta1
+
+
+
+Group        | Version     | Kind
+------------ | ---------- | -----------
+`ant` | `v1beta1` | `Ant`
+
+
+
+
+
+
+
+Ant
+
+
+
+Field        | Description
+------------ | -----------
+`apiVersion`<br /> *string*    | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
+`kind`<br /> *string*    | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
+`metadata`<br /> *[ObjectMeta](#objectmeta-v1)*    | 
+`spec`<br /> *[AntSpec](#antspec-v1beta1)*    | 
+`status`<br /> *[AntStatus](#antstatus-v1beta1)*    | 
+
+
+### AntSpec v1beta1
+
+<aside class="notice">
+Appears In:
+
+<ul>
+<li><a href="#ant-v1beta1">Ant v1beta1</a></li>
+</ul></aside>
+
+Field        | Description
+------------ | -----------
+
+### AntStatus v1beta1
+
+<aside class="notice">
+Appears In:
+
+<ul>
+<li><a href="#ant-v1beta1">Ant v1beta1</a></li>
+</ul></aside>
+
+Field        | Description
+------------ | -----------
+
+
+
+
+

test/docs/expected/includes/_generated_objectmeta_v1_meta_definition.md

@@ -12,6 +12,7 @@ ObjectMeta is metadata that all persisted resources must have, which includes al
 Appears In:
 
 <ul> 
+<li><a href="#ant-v1beta1">Ant v1beta1</a></li>
 <li><a href="#bee-v1beta1">Bee v1beta1</a></li>
 <li><a href="#wasp-v1beta1">Wasp v1beta1</a></li>
 </ul></aside>

test/docs/expected/manifest.json

@@ -1,6 +1,12 @@
 {
   "table_of_contents": {},
   "docs": [
+    {
+      "filename": "_ant.md"
+    },
+    {
+      "filename": "_generated_ant_v1beta1_ant_concept.md"
+    },
     {
       "filename": "_insect.md"
     },