-
-
Notifications
You must be signed in to change notification settings - Fork 2
/
release.go
410 lines (340 loc) · 10.8 KB
/
release.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
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
// Copyright 2022 The Hugoreleaser Authors
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package releasecmd
import (
"context"
_ "embed"
"flag"
"fmt"
"os"
"path/filepath"
"strings"
"text/template"
"github.com/bep/logg"
"github.com/gohugoio/hugoreleaser/cmd/corecmd"
"github.com/gohugoio/hugoreleaser/internal/common/matchers"
"github.com/gohugoio/hugoreleaser/internal/common/templ"
"github.com/gohugoio/hugoreleaser/internal/config"
"github.com/gohugoio/hugoreleaser/internal/releases"
"github.com/gohugoio/hugoreleaser/internal/releases/changelog"
"github.com/gohugoio/hugoreleaser/staticfiles"
"github.com/peterbourgon/ff/v3/ffcli"
)
const commandName = "release"
// New returns a usable ffcli.Command for the release subcommand.
func New(core *corecmd.Core) *ffcli.Command {
fs := flag.NewFlagSet(corecmd.CommandName+" "+commandName, flag.ExitOnError)
releaser := NewReleaser(core, fs)
core.RegisterFlags(fs)
return &ffcli.Command{
Name: "release",
ShortUsage: corecmd.CommandName + " build [flags] <action>",
ShortHelp: "Prepare and publish one or more releases.",
FlagSet: fs,
Exec: releaser.Exec,
}
}
// NewReleaser returns a new Releaser.
func NewReleaser(core *corecmd.Core, fs *flag.FlagSet) *Releaser {
r := &Releaser{
core: core,
}
fs.StringVar(&r.commitish, "commitish", "", "The commitish value that determines where the Git tag is created from.")
return r
}
type Releaser struct {
core *corecmd.Core
infoLog logg.LevelLogger
// Flags
commitish string
}
func (b *Releaser) Init() error {
if b.commitish == "" {
return fmt.Errorf("%s: flag -commitish is required", commandName)
}
b.infoLog = b.core.InfoLog.WithField("cmd", commandName)
releaseMatches := b.core.Config.FindReleases(b.core.PathsReleasesCompiled)
if len(releaseMatches) == 0 {
return fmt.Errorf("%s: no releases found matching -paths %v", commandName, b.core.Paths)
}
for _, r := range releaseMatches {
if err := releases.Validate(r.ReleaseSettings.TypeParsed); err != nil {
return err
}
}
return nil
}
func (b *Releaser) Exec(ctx context.Context, args []string) error {
if err := b.Init(); err != nil {
return err
}
if len(b.core.Config.Releases) == 0 {
return fmt.Errorf("%s: no releases defined in config", commandName)
}
logFields := logg.Fields{
logg.Field{
Name: "tag", Value: b.core.Tag,
},
logg.Field{
Name: "commitish", Value: b.commitish,
},
}
if len(b.core.Paths) > 0 {
logFields = append(logFields, logg.Field{Name: "paths", Value: b.core.Paths})
}
logCtx := b.infoLog.WithFields(logFields)
logCtx.Log(logg.String("Finding releases"))
releaseMatches := b.core.Config.FindReleases(b.core.PathsReleasesCompiled)
for _, release := range releaseMatches {
if err := b.handleRelease(ctx, logCtx, release); err != nil {
return err
}
}
return nil
}
type releaseContext struct {
Ctx context.Context
Log logg.LevelLogger
ReleaseDir string
Client releases.Client
Info releases.ReleaseInfo
}
func (b *Releaser) handleRelease(ctx context.Context, logCtx logg.LevelLogger, release config.Release) error {
releaseDir := filepath.Join(
b.core.DistDir,
b.core.Config.Project,
b.core.Tag,
b.core.DistRootReleases,
filepath.FromSlash(release.Path),
)
info := releases.ReleaseInfo{
Project: b.core.Config.Project,
Tag: b.core.Tag,
Commitish: b.commitish,
Settings: release.ReleaseSettings,
}
var client releases.Client
if b.core.Try {
client = &releases.FakeClient{}
} else {
var err error
client, err = releases.NewClient(ctx, release.ReleaseSettings.TypeParsed)
if err != nil {
return fmt.Errorf("%s: failed to create release client: %v", commandName, err)
}
}
rctx := releaseContext{
Ctx: ctx,
Log: logCtx,
ReleaseDir: releaseDir,
Info: info,
Client: client,
}
if _, err := os.Stat(rctx.ReleaseDir); err == nil || os.IsNotExist(err) {
if !os.IsNotExist(err) {
// Start fresh.
if err := os.RemoveAll(rctx.ReleaseDir); err != nil {
return fmt.Errorf("%s: failed to remove release directory %q: %s", commandName, rctx.ReleaseDir, err)
}
}
if err := os.MkdirAll(releaseDir, 0o755); err != nil {
return fmt.Errorf("%s: failed to create release directory %q: %s", commandName, rctx.ReleaseDir, err)
}
}
// First collect all files to be released.
var archiveFilenames []string
for _, archPath := range release.ArchsCompiled {
archiveDir := filepath.Join(
b.core.DistDir,
b.core.Config.Project,
b.core.Tag,
b.core.DistRootArchives,
filepath.FromSlash(archPath.Path),
)
archiveFilenames = append(archiveFilenames, filepath.Join(archiveDir, archPath.Name))
}
if len(archiveFilenames) == 0 {
return fmt.Errorf("%s: no files found for release %q", commandName, release.Path)
}
if b.core.Try {
return nil
}
checksumFilename, err := b.generateChecksumTxt(rctx, archiveFilenames...)
if err != nil {
return err
}
archiveFilenames = append(archiveFilenames, checksumFilename)
logCtx.Logf("Prepared %d files to archive: %v", len(archiveFilenames), archiveFilenames)
// Generate release notes if needed.
// Write them to the release dir in dist to make testing easier.
if info.Settings.ReleaseNotesSettings.Generate {
releaseNotesFilename, err := b.generateReleaseNotes(rctx)
if err != nil {
return err
}
if releaseNotesFilename == "" {
panic("releaseNotesFilename is empty")
}
info.Settings.ReleaseNotesSettings.Filename = releaseNotesFilename
}
// Now create the release archive and upload files.
releaseID, err := client.Release(ctx, info)
if err != nil {
return fmt.Errorf("%s: failed to create release: %v", commandName, err)
}
r, ctx := b.core.Workforce.Start(ctx)
for _, archiveFilename := range archiveFilenames {
archiveFilename := archiveFilename
r.Run(func() error {
openFile := func() (*os.File, error) {
return os.Open(archiveFilename)
}
logCtx.Logf("Uploading release file %s", archiveFilename)
if err := releases.UploadAssetsFileWithRetries(ctx, client, info, releaseID, openFile); err != nil {
return err
}
return nil
})
}
if err := r.Wait(); err != nil {
return fmt.Errorf("%s: failed to upload files: %v", commandName, err)
}
return nil
}
func (b *Releaser) generateReleaseNotes(rctx releaseContext) (string, error) {
if rctx.Info.Settings.ReleaseNotesSettings.Filename != "" {
return "", fmt.Errorf("%s: both GenerateReleaseNotes and ReleaseNotesFilename are set for release type %q", commandName, rctx.Info.Settings.Type)
}
var resolveUsername func(commit, author string) (string, error)
if unc, ok := rctx.Client.(releases.UsernameResolver); ok {
resolveUsername = func(commit, author string) (string, error) {
return unc.ResolveUsername(rctx.Ctx, commit, author, rctx.Info)
}
}
infos, err := changelog.CollectChanges(
changelog.Options{
Tag: b.core.Tag,
Commitish: b.commitish,
RepoPath: os.Getenv("HUGORELEASER_CHANGELOG_GITREPO"), // Set in tests.
ResolveUserName: resolveUsername,
},
)
if err != nil {
return "", err
}
changeGroups := rctx.Info.Settings.ReleaseNotesSettings.Groups
shortThreshold := rctx.Info.Settings.ReleaseNotesSettings.ShortThreshold
if shortThreshold > 0 && len(infos) < shortThreshold {
shortTitle := rctx.Info.Settings.ReleaseNotesSettings.ShortTitle
if shortTitle == "" {
shortTitle = "What's Changed"
}
var changeGroupsShort []config.ReleaseNotesGroup
// Preserve any ignore groups.
for _, g := range changeGroups {
if g.Ignore {
changeGroupsShort = append(changeGroupsShort, g)
}
}
changeGroupsShort = append(changeGroupsShort, config.ReleaseNotesGroup{Title: shortTitle, RegexpCompiled: matchers.MatchEverything})
changeGroups = changeGroupsShort
}
infosGrouped, err := changelog.GroupByTitleFunc(infos, func(change changelog.Change) (string, int, bool) {
for i, g := range changeGroups {
if g.RegexpCompiled.Match(change.Subject) {
if g.Ignore {
return "", 0, false
}
ordinal := g.Ordinal
if ordinal == 0 {
ordinal = i + 1
}
return g.Title, ordinal, true
}
}
return "", 0, false
})
if err != nil {
return "", err
}
type ReleaseNotesContext struct {
ChangeGroups []changelog.TitleChanges
}
rnc := ReleaseNotesContext{
ChangeGroups: infosGrouped,
}
releaseNotesFilename := filepath.Join(rctx.ReleaseDir, "release-notes.md")
rctx.Info.Settings.ReleaseNotesSettings.Filename = releaseNotesFilename
err = func() error {
f, err := os.Create(releaseNotesFilename)
if err != nil {
return err
}
defer f.Close()
var t *template.Template
if customTemplateFilename := rctx.Info.Settings.ReleaseNotesSettings.TemplateFilename; customTemplateFilename != "" {
if !filepath.IsAbs(customTemplateFilename) {
customTemplateFilename = filepath.Join(b.core.ProjectDir, customTemplateFilename)
}
b, err := os.ReadFile(customTemplateFilename)
if err != nil {
return err
}
t, err = templ.Parse(string(b))
if err != nil {
return err
}
} else {
t = staticfiles.ReleaseNotesTemplate
}
if err := t.Execute(f, rnc); err != nil {
return err
}
return nil
}()
if err != nil {
return "", fmt.Errorf("%s: failed to create release notes file %q: %s", commandName, releaseNotesFilename, err)
}
rctx.Log.WithField("filename", releaseNotesFilename).Log(logg.String("Created release notes"))
return releaseNotesFilename, nil
}
func (b *Releaser) generateChecksumTxt(rctx releaseContext, archiveFilenames ...string) (string, error) {
// Create a checksums.txt file.
checksumLines, err := releases.CreateChecksumLines(b.core.Workforce, archiveFilenames...)
if err != nil {
return "", err
}
// This is what Hugo got out of the box from Goreleaser. No settings for now.
name := fmt.Sprintf("%s_%s_checksums.txt", rctx.Info.Project, strings.TrimPrefix(rctx.Info.Tag, "v"))
checksumFilename := filepath.Join(rctx.ReleaseDir, name)
err = func() error {
f, err := os.Create(checksumFilename)
if err != nil {
return err
}
defer f.Close()
for _, line := range checksumLines {
_, err := f.WriteString(line + "\n")
if err != nil {
return err
}
}
return nil
}()
if err != nil {
return "", fmt.Errorf("%s: failed to create checksum file %q: %s", commandName, checksumFilename, err)
}
rctx.Log.WithField("filename", checksumFilename).Log(logg.String("Created checksum file"))
return checksumFilename, nil
}