-
Notifications
You must be signed in to change notification settings - Fork 432
/
generate_changelog_doc.go
236 lines (210 loc) · 6.16 KB
/
generate_changelog_doc.go
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
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
package main
import (
"context"
"fmt"
"os"
"github.com/google/go-github/v31/github"
"github.com/rotisserie/eris"
. "github.com/solo-io/gloo/docs/cmd/changelogutils"
. "github.com/solo-io/go-utils/versionutils"
"github.com/spf13/cobra"
"golang.org/x/oauth2"
)
func main() {
ctx := context.Background()
app := rootApp(ctx)
if err := app.Execute(); err != nil {
fmt.Printf("unable to run: %v\n", err)
os.Exit(1)
}
}
type options struct {
ctx context.Context
HugoDataSoloOpts HugoDataSoloOpts
}
type HugoDataSoloOpts struct {
product string
version string
// if set, will override the version when rendering the
callLatest bool
noScope bool
}
func rootApp(ctx context.Context) *cobra.Command {
opts := &options{
ctx: ctx,
}
app := &cobra.Command{
Use: "docs-util",
RunE: func(cmd *cobra.Command, args []string) error {
return nil
},
}
app.AddCommand(changelogMdFromGithubCmd(opts))
app.AddCommand(minorReleaseChangelogMdFromGithubCmd(opts))
app.PersistentFlags().StringVar(&opts.HugoDataSoloOpts.version, "version", "", "version of docs and code")
app.PersistentFlags().StringVar(&opts.HugoDataSoloOpts.product, "product", "gloo", "product to which the docs refer (defaults to gloo)")
app.PersistentFlags().BoolVar(&opts.HugoDataSoloOpts.noScope, "no-scope", false, "if set, will not nest the served docs by product or version")
app.PersistentFlags().BoolVar(&opts.HugoDataSoloOpts.callLatest, "call-latest", false, "if set, will use the string 'latest' in the scope, rather than the particular release version")
return app
}
func changelogMdFromGithubCmd(opts *options) *cobra.Command {
app := &cobra.Command{
Use: "gen-changelog-md",
Short: "generate a markdown file from Github Release pages API",
RunE: func(cmd *cobra.Command, args []string) error {
if os.Getenv(skipChangelogGeneration) != "" {
return nil
}
return generateChangelogMd(args)
},
}
return app
}
func minorReleaseChangelogMdFromGithubCmd(opts *options) *cobra.Command {
app := &cobra.Command{
Use: "gen-minor-releases-changelog-md",
Short: "generate an aggregated changelog markdown file for each minor release version",
RunE: func(cmd *cobra.Command, args []string) error {
if os.Getenv(skipChangelogGeneration) != "" {
return nil
}
return generateMinorReleaseChangelog(args)
},
}
return app
}
const (
latestVersionPath = "latest"
)
const (
glooDocGen = "gloo"
glooEDocGen = "glooe"
skipChangelogGeneration = "SKIP_CHANGELOG_GENERATION"
)
const (
glooOpenSourceRepo = "gloo"
glooEnterpriseRepo = "solo-projects"
)
var (
InvalidInputError = func(arg string) error {
return eris.Errorf("invalid input, must provide exactly one argument, either '%v' or '%v', (provided %v)",
glooDocGen,
glooEDocGen,
arg)
}
MissingGithubTokenError = func() error {
return eris.Errorf("Must either set GITHUB_TOKEN or set %s environment variable to true", skipChangelogGeneration)
}
)
// Generates changelog for releases as fetched from Github
// Github defaults to a chronological order
func generateChangelogMd(args []string) error {
if len(args) != 1 {
return InvalidInputError(fmt.Sprintf("%v", len(args)-1))
}
client := github.NewClient(nil)
target := args[0]
var repo string
switch target {
case glooDocGen:
repo = glooOpenSourceRepo
allReleases, err := GetAllReleases(client, repo)
if err != nil {
return err
}
for _, release := range allReleases {
fmt.Printf("### %v\n\n", release.GetTagName())
fmt.Printf("%v", release.GetBody())
}
case glooEDocGen:
err := generateGlooEChangelog(false)
if err != nil {
return err
}
default:
return InvalidInputError(target)
}
return nil
}
// Performs additional processing to generate changelog grouped and ordered by release version
func generateMinorReleaseChangelog(args []string) error {
if len(args) != 1 {
return InvalidInputError(fmt.Sprintf("%v", len(args)-1))
}
target := args[0]
var (
err error
)
switch target {
case glooDocGen:
err = generateGlooChangelog()
case glooEDocGen:
err = generateGlooEChangelog(true)
default:
return InvalidInputError(target)
}
return err
}
// Fetches Gloo Open Source releases and orders them by version
func generateGlooChangelog() error {
client := github.NewClient(nil)
allReleases, err := GetAllReleases(client, glooOpenSourceRepo)
allReleases = SortReleases(allReleases)
if err != nil {
return err
}
minorReleaseMap, err := ParseReleases(allReleases, true)
if err != nil {
return err
}
printVersionOrderReleases(minorReleaseMap, nil)
return nil
}
// Fetches Gloo Enterprise releases, merges in open source release notes, and orders them by version
func generateGlooEChangelog(sortedByVersion bool) error {
// Initialize Auth
ctx := context.Background()
if os.Getenv("GITHUB_TOKEN") == "" {
return MissingGithubTokenError()
}
ts := oauth2.StaticTokenSource(
&oauth2.Token{AccessToken: os.Getenv("GITHUB_TOKEN")},
)
tc := oauth2.NewClient(ctx, ts)
client := github.NewClient(tc)
// Get all Gloo OSS release changelogs
enterpriseReleases, err := GetAllReleases(client, glooEnterpriseRepo)
if err != nil {
return err
}
openSourceReleases, err := GetAllReleases(client, glooOpenSourceRepo)
if err != nil {
return err
}
openSourceReleasesSorted := SortReleases(openSourceReleases)
minorReleaseMap, versionOrder, err := MergeEnterpriseOSSReleases(enterpriseReleases, openSourceReleasesSorted, sortedByVersion)
if err != nil {
return err
}
printVersionOrderReleases(minorReleaseMap, versionOrder)
return nil
}
// Outputs changelogs in markdown format
func printVersionOrderReleases(minorReleaseMap map[Version]string, versionOrder []Version) {
// if no version order is given, sort the versions by minor release
versions := versionOrder
// if versions (versionOrder) is nil, we want to sort the minorReleaseMap versions
if versions == nil {
for minorVersion, _ := range minorReleaseMap {
versions = append(versions, minorVersion)
}
versions = SortReleaseVersions(versions)
}
for _, version := range versions {
body := minorReleaseMap[version]
if versionOrder == nil {
fmt.Printf("\n\n### v%d.%d\n\n", version.Major, version.Minor)
}
fmt.Printf("%v", body)
}
}