Files
argo-cd/hack/gen-docs/main.go
Matthieu MOREL 9ea979bbcd chore: enable use-any from revive (#21282)
Signed-off-by: Matthieu MOREL <matthieu.morel35@gmail.com>
2025-01-02 18:26:59 -05:00

101 lines
2.6 KiB
Go

package main
import (
"bytes"
"fmt"
"log"
"os"
"sort"
"strings"
"gopkg.in/yaml.v2"
"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
"github.com/argoproj/notifications-engine/pkg/docs"
)
func main() {
generateNotificationsDocs()
}
func generateNotificationsDocs() {
_ = os.RemoveAll("./docs/operator-manual/notifications/services")
_ = os.MkdirAll("./docs/operator-manual/notifications/services", 0o755)
files, err := docs.CopyServicesDocs("./docs/operator-manual/notifications/services")
if err != nil {
log.Fatal(err)
}
if files != nil {
if e := updateMkDocsNav("Operator Manual", "Notifications", "Notification Services", files); e != nil {
log.Fatal(e)
}
}
}
func updateMkDocsNav(parent string, child string, subchild string, files []string) error {
trimPrefixes(files, "docs/")
sort.Strings(files)
data, err := os.ReadFile("mkdocs.yml")
if err != nil {
return fmt.Errorf("error reading mkdocs.yml: %w", err)
}
var un unstructured.Unstructured
if e := yaml.Unmarshal(data, &un.Object); e != nil {
return e
}
nav := un.Object["nav"].([]any)
rootitem, _ := findNavItem(nav, parent)
if rootitem == nil {
return fmt.Errorf("can't find '%s' root item in mkdoc.yml", parent)
}
rootnavitemmap := rootitem.(map[any]any)
childnav, _ := findNavItem(rootnavitemmap[parent].([]any), child)
if childnav == nil {
return fmt.Errorf("can't find '%s' chile item under '%s' parent item in mkdoc.yml", child, parent)
}
childnavmap := childnav.(map[any]any)
childnavitems := childnavmap[child].([]any)
childnavitems = removeNavItem(childnavitems, subchild)
commands := make(map[string]any)
commands[subchild] = files
childnavmap[child] = append(childnavitems, commands)
newmkdocs, err := yaml.Marshal(un.Object)
if err != nil {
return fmt.Errorf("error in marshaling final configmap: %w", err)
}
// The marshaller drops custom tags, so re-add this one. Turns out this is much less invasive than trying to handle
// it at the YAML parser level.
newmkdocs = bytes.Replace(newmkdocs, []byte("site_url: READTHEDOCS_CANONICAL_URL"), []byte("site_url: !ENV READTHEDOCS_CANONICAL_URL"), 1)
return os.WriteFile("mkdocs.yml", newmkdocs, 0o644)
}
func trimPrefixes(files []string, prefix string) {
for i, f := range files {
files[i] = strings.TrimPrefix(f, prefix)
}
}
func findNavItem(nav []any, key string) (any, int) {
for i, item := range nav {
o, ismap := item.(map[any]any)
if ismap {
if _, ok := o[key]; ok {
return o, i
}
}
}
return nil, -1
}
func removeNavItem(nav []any, key string) []any {
_, i := findNavItem(nav, key)
if i != -1 {
nav = append(nav[:i], nav[i+1:]...)
}
return nav
}