|
| 1 | +// |
| 2 | +// DISCLAIMER |
| 3 | +// |
| 4 | +// Copyright 2023 ArangoDB GmbH, Cologne, Germany |
| 5 | +// |
| 6 | +// Licensed under the Apache License, Version 2.0 (the "License"); |
| 7 | +// you may not use this file except in compliance with the License. |
| 8 | +// You may obtain a copy of the License at |
| 9 | +// |
| 10 | +// http://www.apache.org/licenses/LICENSE-2.0 |
| 11 | +// |
| 12 | +// Unless required by applicable law or agreed to in writing, software |
| 13 | +// distributed under the License is distributed on an "AS IS" BASIS, |
| 14 | +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 15 | +// See the License for the specific language governing permissions and |
| 16 | +// limitations under the License. |
| 17 | +// |
| 18 | +// Copyright holder is ArangoDB GmbH, Cologne, Germany |
| 19 | +// |
| 20 | + |
| 21 | +package internal |
| 22 | + |
| 23 | +import ( |
| 24 | + "os" |
| 25 | + "path" |
| 26 | + |
| 27 | + "gopkg.in/yaml.v3" |
| 28 | + |
| 29 | + "github.com/arangodb/kube-arangodb/internal/md" |
| 30 | + "github.com/arangodb/kube-arangodb/pkg/util" |
| 31 | +) |
| 32 | + |
| 33 | +type PlatformsDoc struct { |
| 34 | + Platforms Platforms `json:"platforms,omitempty" yaml:"platforms,omitempty"` |
| 35 | +} |
| 36 | + |
| 37 | +type Platforms []Platform |
| 38 | + |
| 39 | +type Platform struct { |
| 40 | + Name string `json:"name,omitempty" yaml:"name,omitempty"` |
| 41 | + Versions []PlatformVersion `json:"versions,omitempty" yaml:"versions,omitempty"` |
| 42 | +} |
| 43 | + |
| 44 | +type PlatformVersion struct { |
| 45 | + KubernetesVersion *string `json:"kubernetesVersion,omitempty" yaml:"kubernetesVersion,omitempty"` |
| 46 | + ArangoDBVersion *string `json:"arangoDBVersion,omitempty" yaml:"arangoDBVersion,omitempty"` |
| 47 | + State *string `json:"state,omitempty" yaml:"state,omitempty"` |
| 48 | + Remarks *string `json:"remarks,omitempty" yaml:"remarks,omitempty"` |
| 49 | + ProviderRemarks *string `json:"providerRemarks,omitempty" yaml:"providerRemarks,omitempty"` |
| 50 | +} |
| 51 | + |
| 52 | +func GenerateReadme(root string) error { |
| 53 | + readmeSections := map[string]string{} |
| 54 | + |
| 55 | + { |
| 56 | + platform := md.NewColumn("Platform", md.ColumnLeftAlign) |
| 57 | + kVersion := md.NewColumn("Kubernetes Version", md.ColumnLeftAlign) |
| 58 | + aVersion := md.NewColumn("ArangoDB Version", md.ColumnLeftAlign) |
| 59 | + state := md.NewColumn("State", md.ColumnLeftAlign) |
| 60 | + remarks := md.NewColumn("Remarks", md.ColumnLeftAlign) |
| 61 | + pRemarks := md.NewColumn("Provider Remarks", md.ColumnLeftAlign) |
| 62 | + t := md.NewTable( |
| 63 | + platform, |
| 64 | + kVersion, |
| 65 | + aVersion, |
| 66 | + state, |
| 67 | + remarks, |
| 68 | + pRemarks, |
| 69 | + ) |
| 70 | + |
| 71 | + var d PlatformsDoc |
| 72 | + |
| 73 | + data, err := os.ReadFile(path.Join(root, "internal", "platforms.yaml")) |
| 74 | + if err != nil { |
| 75 | + return err |
| 76 | + } |
| 77 | + |
| 78 | + if err := yaml.Unmarshal(data, &d); err != nil { |
| 79 | + return err |
| 80 | + } |
| 81 | + |
| 82 | + for _, p := range d.Platforms { |
| 83 | + for _, v := range p.Versions { |
| 84 | + if err := t.AddRow(map[md.Column]string{ |
| 85 | + platform: p.Name, |
| 86 | + kVersion: util.StringOrDefault(v.KubernetesVersion, ""), |
| 87 | + aVersion: util.StringOrDefault(v.ArangoDBVersion, ""), |
| 88 | + state: util.StringOrDefault(v.State, ""), |
| 89 | + remarks: util.StringOrDefault(v.Remarks, ""), |
| 90 | + pRemarks: util.StringOrDefault(v.ProviderRemarks, ""), |
| 91 | + }); err != nil { |
| 92 | + return err |
| 93 | + } |
| 94 | + } |
| 95 | + } |
| 96 | + |
| 97 | + readmeSections["metricsTable"] = md.WrapWithNewLines(t.Render()) |
| 98 | + } |
| 99 | + |
| 100 | + if err := md.ReplaceSectionsInFile(path.Join(root, "README.md"), readmeSections); err != nil { |
| 101 | + return err |
| 102 | + } |
| 103 | + |
| 104 | + return nil |
| 105 | +} |
0 commit comments