1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
|
package main
import (
"bytes"
"fmt"
"io"
"io/ioutil"
"strings"
"text/template"
"gitlab.com/gitlab-org/gitlab-runner/helpers/featureflags"
)
const (
docsFile = "./docs/configuration/feature-flags.md"
startPlaceholder = "<!-- feature_flags_list_start -->"
endPlaceholder = "<!-- feature_flags_list_end -->"
)
//nolint:lll
var ffTableTemplate = `{{ placeholder "start" }}
| Feature flag | Default value | Deprecated | To be removed with | Description |
|--------------|---------------|------------|--------------------|-------------|
{{ range $_, $flag := . -}}
| {{ $flag.Name | raw }} | {{ $flag.DefaultValue | bool }} | {{ $flag.Deprecated | tick }} | {{ $flag.ToBeRemovedWith }} | {{ $flag.Description }} |
{{ end }}
{{ placeholder "end" }}
`
func main() {
fileContent := getFileContent()
tableContent := prepareTable()
newFileContent := replace(fileContent, tableContent)
saveFileContent(newFileContent)
}
func getFileContent() string {
data, err := ioutil.ReadFile(docsFile)
if err != nil {
panic(fmt.Sprintf("Error while reading file %q: %v", docsFile, err))
}
return string(data)
}
func prepareTable() string {
tpl := template.New("ffTable")
tpl.Funcs(template.FuncMap{
"placeholder": func(placeholderType string) string {
switch placeholderType {
case "start":
return startPlaceholder
case "end":
return endPlaceholder
default:
panic(fmt.Sprintf("Undefined placeholder type %q", placeholderType))
}
},
"raw": func(input string) string {
return fmt.Sprintf("`%s`", input)
},
"bool": func(input bool) string {
return fmt.Sprintf("`%t`", input)
},
"tick": func(input bool) string {
if input {
return "**{check-circle}** Yes"
}
return "**{dotted-circle}** No"
},
})
tpl, err := tpl.Parse(ffTableTemplate)
if err != nil {
panic(fmt.Sprintf("Error while parsing the template: %v", err))
}
buffer := new(bytes.Buffer)
err = tpl.Execute(buffer, featureflags.GetAll())
if err != nil {
panic(fmt.Sprintf("Error while executing the template: %v", err))
}
return buffer.String()
}
func replace(fileContent, tableContent string) string {
replacer := newBlockLineReplacer(startPlaceholder, endPlaceholder, fileContent, tableContent)
newContent, err := replacer.Replace()
if err != nil {
panic(fmt.Sprintf("Error while replacing the content: %v", err))
}
return newContent
}
func saveFileContent(newFileContent string) {
err := ioutil.WriteFile(docsFile, []byte(newFileContent), 0644)
if err != nil {
panic(fmt.Sprintf("Error while writing new content for %q file: %v", docsFile, err))
}
}
type blockLineReplacer struct {
startLine string
endLine string
replaceContent string
input *bytes.Buffer
output *bytes.Buffer
startFound bool
endFound bool
}
func (r *blockLineReplacer) Replace() (string, error) {
for {
line, err := r.input.ReadString('\n')
if err == io.EOF {
break
}
if err != nil {
return "", fmt.Errorf("error while reading issue description: %w", err)
}
r.handleLine(line)
}
return r.output.String(), nil
}
func (r *blockLineReplacer) handleLine(line string) {
r.handleStart(line)
r.handleRewrite(line)
r.handleEnd(line)
}
func (r *blockLineReplacer) handleStart(line string) {
if r.startFound || !strings.Contains(line, r.startLine) {
return
}
r.startFound = true
}
func (r *blockLineReplacer) handleRewrite(line string) {
if r.startFound && !r.endFound {
return
}
r.output.WriteString(line)
}
func (r *blockLineReplacer) handleEnd(line string) {
if !strings.Contains(line, r.endLine) {
return
}
r.endFound = true
r.output.WriteString(r.replaceContent)
}
func newBlockLineReplacer(startLine, endLine string, input, replaceContent string) *blockLineReplacer {
return &blockLineReplacer{
startLine: startLine,
endLine: endLine,
input: bytes.NewBufferString(input),
output: new(bytes.Buffer),
replaceContent: replaceContent,
startFound: false,
endFound: false,
}
}
|
