-
Notifications
You must be signed in to change notification settings - Fork 0
/
release.go
634 lines (506 loc) · 15.1 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
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
package commands
import (
"fmt"
"io"
"os"
"path/filepath"
"strings"
"time"
"github.com/github/hub/github"
"github.com/github/hub/ui"
"github.com/github/hub/utils"
)
var (
cmdRelease = &Command{
Run: listReleases,
Usage: `
release [--include-drafts] [--exclude-prereleases] [-L <LIMIT>] [-f <FORMAT>]
release show [-f <FORMAT>] <TAG>
release create [-dpoc] [-a <FILE>] [-m <MESSAGE>|-F <FILE>] [-t <TARGET>] <TAG>
release edit [<options>] <TAG>
release download <TAG>
release delete <TAG>
`,
Long: `Manage GitHub Releases for the current repository.
## Commands:
With no arguments, shows a list of existing releases.
With '--include-drafts', include draft releases in the listing.
With '--exclude-prereleases', exclude non-stable releases from the listing.
* _show_:
Show GitHub release notes for <TAG>.
With '--show-downloads', include the "Downloads" section.
* _create_:
Create a GitHub release for the specified <TAG> name. If git tag <TAG>
does not exist, it will be created at <TARGET> (default: current branch).
* _edit_:
Edit the GitHub release for the specified <TAG> name. Accepts the same
options as _create_ command. Publish a draft with '--draft=false'.
When <MESSAGE> or <FILE> are not specified, a text editor will open
pre-populated with current release title and body. To re-use existing title
and body unchanged, pass '-m ""'.
* _download_:
Download the assets attached to release for the specified <TAG>.
* _delete_:
Delete the release and associated assets for the specified <TAG>. Note that
this does **not** remove the git tag <TAG>.
## Options:
-L, --limit
Display only the first <LIMIT> releases.
-d, --draft
Create a draft release.
-p, --prerelease
Create a pre-release.
-a, --attach <FILE>
Attach a file as an asset for this release.
If <FILE> is in the "<filename>#<text>" format, the text after the '#'
character is taken as asset label.
-m, --message <MESSAGE>
The text up to the first blank line in <MESSAGE> is treated as the release
title, and the rest is used as release description in Markdown format.
If multiple <MESSAGE> options are given, their values are concatenated as
separate paragraphs.
-F, --file <FILE>
Read the release title and description from <FILE>.
-e, --edit
Further edit the contents of <FILE> in a text editor before submitting.
-o, --browse
Open the new release in a web browser.
-c, --copy
Put the URL of the new release to clipboard instead of printing it.
-t, --commitish <TARGET>
A commit SHA or branch name to attach the release to, only used if <TAG>
does not already exist (default: main branch).
-f, --format <FORMAT>
Pretty print releases using <FORMAT> (default: "%T%n"). See the "PRETTY
FORMATS" section of git-log(1) for some additional details on how
placeholders are used in format. The available placeholders for issues are:
%U: the URL of this release
%uT: tarball URL
%uZ: zipball URL
%uA: asset upload URL
%S: state (i.e. "draft", "pre-release")
%sC: set color to yellow or red, depending on state
%t: release name
%T: release tag
%b: body
%as: the list of assets attached to this release
%cD: created date-only (no time of day)
%cr: created date, relative
%ct: created date, UNIX timestamp
%cI: created date, ISO 8601 format
%pD: published date-only (no time of day)
%pr: published date, relative
%pt: published date, UNIX timestamp
%pI: published date, ISO 8601 format
%n: newline
%%: a literal %
--color[=<WHEN>]
Enable colored output even if stdout is not a terminal. <WHEN> can be one
of "always" (default for '--color'), "never", or "auto" (default).
<TAG>
The git tag name for this release.
## See also:
hub(1), git-tag(1)
`,
KnownFlags: `
-d, --include-drafts
-p, --exclude-prereleases
-L, --limit N
-f, --format FMT
--color
`,
}
cmdShowRelease = &Command{
Key: "show",
Run: showRelease,
KnownFlags: `
-d, --show-downloads
-f, --format FMT
--color
`,
}
cmdCreateRelease = &Command{
Key: "create",
Run: createRelease,
KnownFlags: `
-e, --edit
-d, --draft
-p, --prerelease
-o, --browse
-c, --copy
-a, --attach FILE
-m, --message MSG
-F, --file FILE
-t, --commitish C
`,
}
cmdEditRelease = &Command{
Key: "edit",
Run: editRelease,
KnownFlags: `
-e, --edit
-d, --draft
-p, --prerelease
-a, --attach FILE
-m, --message MSG
-F, --file FILE
-t, --commitish C
`,
}
cmdDownloadRelease = &Command{
Key: "download",
Run: downloadRelease,
}
cmdDeleteRelease = &Command{
Key: "delete",
Run: deleteRelease,
}
)
func init() {
cmdRelease.Use(cmdShowRelease)
cmdRelease.Use(cmdCreateRelease)
cmdRelease.Use(cmdEditRelease)
cmdRelease.Use(cmdDownloadRelease)
cmdRelease.Use(cmdDeleteRelease)
CmdRunner.Use(cmdRelease)
}
func listReleases(cmd *Command, args *Args) {
localRepo, err := github.LocalRepo()
utils.Check(err)
project, err := localRepo.MainProject()
utils.Check(err)
gh := github.NewClient(project.Host)
flagReleaseLimit := args.Flag.Int("--limit")
flagReleaseIncludeDrafts := args.Flag.Bool("--include-drafts")
flagReleaseExcludePrereleases := args.Flag.Bool("--exclude-prereleases")
if args.Noop {
ui.Printf("Would request list of releases for %s\n", project)
} else {
releases, err := gh.FetchReleases(project, flagReleaseLimit, func(release *github.Release) bool {
return (!release.Draft || flagReleaseIncludeDrafts) &&
(!release.Prerelease || !flagReleaseExcludePrereleases)
})
utils.Check(err)
colorize := colorizeOutput(args.Flag.HasReceived("--color"), args.Flag.Value("--color"))
for _, release := range releases {
flagReleaseFormat := "%T%n"
if args.Flag.HasReceived("--format") {
flagReleaseFormat = args.Flag.Value("--format")
}
ui.Print(formatRelease(release, flagReleaseFormat, colorize))
}
}
args.NoForward()
}
func formatRelease(release github.Release, format string, colorize bool) string {
state := ""
stateColorSwitch := ""
if release.Draft {
state = "draft"
stateColorSwitch = fmt.Sprintf("\033[%dm", 33)
} else if release.Prerelease {
state = "pre-release"
stateColorSwitch = fmt.Sprintf("\033[%dm", 31)
}
var createdDate, createdAtISO8601, createdAtUnix, createdAtRelative,
publishedDate, publishedAtISO8601, publishedAtUnix, publishedAtRelative string
if !release.CreatedAt.IsZero() {
createdDate = release.CreatedAt.Format("02 Jan 2006")
createdAtISO8601 = release.CreatedAt.Format(time.RFC3339)
createdAtUnix = fmt.Sprintf("%d", release.CreatedAt.Unix())
createdAtRelative = utils.TimeAgo(release.CreatedAt)
}
if !release.PublishedAt.IsZero() {
publishedDate = release.PublishedAt.Format("02 Jan 2006")
publishedAtISO8601 = release.PublishedAt.Format(time.RFC3339)
publishedAtUnix = fmt.Sprintf("%d", release.PublishedAt.Unix())
publishedAtRelative = utils.TimeAgo(release.PublishedAt)
}
assets := make([]string, len(release.Assets))
for i, asset := range release.Assets {
assets[i] = fmt.Sprintf("%s\t%s", asset.DownloadUrl, asset.Label)
}
placeholders := map[string]string{
"U": release.HtmlUrl,
"uT": release.TarballUrl,
"uZ": release.ZipballUrl,
"uA": release.UploadUrl,
"S": state,
"sC": stateColorSwitch,
"t": release.Name,
"T": release.TagName,
"b": release.Body,
"as": strings.Join(assets, "\n"),
"cD": createdDate,
"cI": createdAtISO8601,
"ct": createdAtUnix,
"cr": createdAtRelative,
"pD": publishedDate,
"pI": publishedAtISO8601,
"pt": publishedAtUnix,
"pr": publishedAtRelative,
}
return ui.Expand(format, placeholders, colorize)
}
func showRelease(cmd *Command, args *Args) {
tagName := ""
if args.ParamsSize() > 0 {
tagName = args.GetParam(0)
}
if tagName == "" {
utils.Check(cmd.UsageError(""))
}
localRepo, err := github.LocalRepo()
utils.Check(err)
project, err := localRepo.MainProject()
utils.Check(err)
gh := github.NewClient(project.Host)
args.NoForward()
if args.Noop {
ui.Printf("Would display information for `%s' release\n", tagName)
} else {
release, err := gh.FetchRelease(project, tagName)
utils.Check(err)
body := strings.TrimSpace(release.Body)
colorize := colorizeOutput(args.Flag.HasReceived("--color"), args.Flag.Value("--color"))
if flagShowReleaseFormat := args.Flag.Value("--format"); flagShowReleaseFormat != "" {
ui.Print(formatRelease(*release, flagShowReleaseFormat, colorize))
return
}
ui.Println(release.Name)
if body != "" {
ui.Printf("\n%s\n", body)
}
if args.Flag.Bool("--show-downloads") {
ui.Printf("\n## Downloads\n\n")
for _, asset := range release.Assets {
ui.Println(asset.DownloadUrl)
}
if release.ZipballUrl != "" {
ui.Println(release.ZipballUrl)
ui.Println(release.TarballUrl)
}
}
}
}
func downloadRelease(cmd *Command, args *Args) {
tagName := ""
if args.ParamsSize() > 0 {
tagName = args.GetParam(0)
}
if tagName == "" {
utils.Check(cmd.UsageError(""))
}
localRepo, err := github.LocalRepo()
utils.Check(err)
project, err := localRepo.MainProject()
utils.Check(err)
gh := github.NewClient(project.Host)
release, err := gh.FetchRelease(project, tagName)
utils.Check(err)
for _, asset := range release.Assets {
ui.Printf("Downloading %s ...\n", asset.Name)
err := downloadReleaseAsset(asset, gh)
utils.Check(err)
}
args.NoForward()
}
func downloadReleaseAsset(asset github.ReleaseAsset, gh *github.Client) (err error) {
assetReader, err := gh.DownloadReleaseAsset(asset.ApiUrl)
if err != nil {
return
}
defer assetReader.Close()
assetFile, err := os.OpenFile(asset.Name, os.O_WRONLY|os.O_CREATE|os.O_EXCL, 0644)
if err != nil {
return
}
defer assetFile.Close()
_, err = io.Copy(assetFile, assetReader)
if err != nil {
return
}
return
}
func createRelease(cmd *Command, args *Args) {
tagName := ""
if args.ParamsSize() > 0 {
tagName = args.GetParam(0)
}
if tagName == "" {
utils.Check(cmd.UsageError(""))
return
}
localRepo, err := github.LocalRepo()
utils.Check(err)
project, err := localRepo.MainProject()
utils.Check(err)
gh := github.NewClient(project.Host)
messageBuilder := &github.MessageBuilder{
Filename: "RELEASE_EDITMSG",
Title: "release",
}
messageBuilder.AddCommentedSection(fmt.Sprintf(`Creating release %s for %s
Write a message for this release. The first block of
text is the title and the rest is the description.`, tagName, project))
flagReleaseMessage := args.Flag.AllValues("--message")
if len(flagReleaseMessage) > 0 {
messageBuilder.Message = strings.Join(flagReleaseMessage, "\n\n")
messageBuilder.Edit = args.Flag.Bool("--edit")
} else if args.Flag.HasReceived("--file") {
messageBuilder.Message, err = msgFromFile(args.Flag.Value("--file"))
utils.Check(err)
messageBuilder.Edit = args.Flag.Bool("--edit")
} else {
messageBuilder.Edit = true
}
title, body, err := messageBuilder.Extract()
utils.Check(err)
if title == "" {
utils.Check(fmt.Errorf("Aborting release due to empty release title"))
}
params := &github.Release{
TagName: tagName,
TargetCommitish: args.Flag.Value("--commitish"),
Name: title,
Body: body,
Draft: args.Flag.Bool("--draft"),
Prerelease: args.Flag.Bool("--prerelease"),
}
var release *github.Release
args.NoForward()
if args.Noop {
ui.Printf("Would create release `%s' for %s with tag name `%s'\n", title, project, tagName)
} else {
release, err = gh.CreateRelease(project, params)
utils.Check(err)
flagReleaseBrowse := args.Flag.Bool("--browse")
flagReleaseCopy := args.Flag.Bool("--copy")
printBrowseOrCopy(args, release.HtmlUrl, flagReleaseBrowse, flagReleaseCopy)
}
messageBuilder.Cleanup()
flagReleaseAssets := args.Flag.AllValues("--attach")
uploadAssets(gh, release, flagReleaseAssets, args)
}
func editRelease(cmd *Command, args *Args) {
tagName := ""
if args.ParamsSize() > 0 {
tagName = args.GetParam(0)
}
if tagName == "" {
utils.Check(cmd.UsageError(""))
return
}
localRepo, err := github.LocalRepo()
utils.Check(err)
project, err := localRepo.MainProject()
utils.Check(err)
gh := github.NewClient(project.Host)
release, err := gh.FetchRelease(project, tagName)
utils.Check(err)
params := map[string]interface{}{}
if args.Flag.HasReceived("--commitish") {
params["target_commitish"] = args.Flag.Value("--commitish")
}
if args.Flag.HasReceived("--draft") {
params["draft"] = args.Flag.Bool("--draft")
}
if args.Flag.HasReceived("--prerelease") {
params["prerelease"] = args.Flag.Bool("--prerelease")
}
messageBuilder := &github.MessageBuilder{
Filename: "RELEASE_EDITMSG",
Title: "release",
}
messageBuilder.AddCommentedSection(fmt.Sprintf(`Editing release %s for %s
Write a message for this release. The first block of
text is the title and the rest is the description.`, tagName, project))
flagReleaseMessage := args.Flag.AllValues("--message")
if len(flagReleaseMessage) > 0 {
messageBuilder.Message = strings.Join(flagReleaseMessage, "\n\n")
messageBuilder.Edit = args.Flag.Bool("--edit")
} else if args.Flag.HasReceived("--file") {
messageBuilder.Message, err = msgFromFile(args.Flag.Value("--file"))
utils.Check(err)
messageBuilder.Edit = args.Flag.Bool("--edit")
} else {
messageBuilder.Edit = true
messageBuilder.Message = fmt.Sprintf("%s\n\n%s", release.Name, release.Body)
}
title, body, err := messageBuilder.Extract()
utils.Check(err)
if title == "" && len(flagReleaseMessage) == 0 {
utils.Check(fmt.Errorf("Aborting editing due to empty release title"))
}
if title != "" {
params["name"] = title
}
if body != "" {
params["body"] = body
}
if len(params) > 0 {
if args.Noop {
ui.Printf("Would edit release `%s'\n", tagName)
} else {
release, err = gh.EditRelease(release, params)
utils.Check(err)
}
messageBuilder.Cleanup()
}
flagReleaseAssets := args.Flag.AllValues("--attach")
uploadAssets(gh, release, flagReleaseAssets, args)
args.NoForward()
}
func deleteRelease(cmd *Command, args *Args) {
tagName := ""
if args.ParamsSize() > 0 {
tagName = args.GetParam(0)
}
if tagName == "" {
utils.Check(cmd.UsageError(""))
return
}
localRepo, err := github.LocalRepo()
utils.Check(err)
project, err := localRepo.MainProject()
utils.Check(err)
gh := github.NewClient(project.Host)
release, err := gh.FetchRelease(project, tagName)
utils.Check(err)
if args.Noop {
message := fmt.Sprintf("Deleting release related to %s...", tagName)
ui.Println(message)
} else {
err = gh.DeleteRelease(release)
utils.Check(err)
}
args.NoForward()
}
func uploadAssets(gh *github.Client, release *github.Release, assets []string, args *Args) {
for _, asset := range assets {
var label string
parts := strings.SplitN(asset, "#", 2)
asset = parts[0]
if len(parts) > 1 {
label = parts[1]
}
if args.Noop {
if label == "" {
ui.Errorf("Would attach release asset `%s'\n", asset)
} else {
ui.Errorf("Would attach release asset `%s' with label `%s'\n", asset, label)
}
} else {
for _, existingAsset := range release.Assets {
if existingAsset.Name == filepath.Base(asset) {
err := gh.DeleteReleaseAsset(&existingAsset)
utils.Check(err)
break
}
}
ui.Errorf("Attaching release asset `%s'...\n", asset)
_, err := gh.UploadReleaseAsset(release, asset, label)
utils.Check(err)
}
}
}