GitLabgitlab-org

cli

main
ply8 git calls210 ms99 KiB6 cachedprotocol v2
158 lines4.1 KiBRaw
1package list
3import (
4 "github.com/MakeNowJust/heredoc/v2"
5 "github.com/spf13/cobra"
7 gitlab "gitlab.com/gitlab-org/api/client-go/v3"
9 "gitlab.com/gitlab-org/cli/internal/cmdutils"
10 "gitlab.com/gitlab-org/cli/internal/commands/release/releaseutils"
11 "gitlab.com/gitlab-org/cli/internal/config"
12 "gitlab.com/gitlab-org/cli/internal/glrepo"
13 "gitlab.com/gitlab-org/cli/internal/iostreams"
14 "gitlab.com/gitlab-org/cli/internal/mcpannotations"
15 "gitlab.com/gitlab-org/cli/internal/utils"
18var getRelease = func(client *gitlab.Client, projectID any, tag string) (*gitlab.Release, error) {
19 release, _, err := client.Releases.GetRelease(projectID, tag)
20 if err != nil {
21 return nil, err
22 }
24 return release, nil
27var listReleases = func(client *gitlab.Client, projectID any, opts *gitlab.ListReleasesOptions) ([]*gitlab.Release, *gitlab.Response, error) {
28 return client.Releases.ListReleases(projectID, opts)
31type options struct {
32 outputFormat string
34 io *iostreams.IOStreams
35 gitlabClient func() (*gitlab.Client, error)
36 baseRepo func() (glrepo.Interface, error)
37 config func() config.Config
40func NewCmdReleaseList(f cmdutils.Factory) *cobra.Command {
41 opts := &options{
42 io: f.IO(),
43 gitlabClient: f.GitLabClient,
44 baseRepo: f.BaseRepo,
45 config: f.Config,
46 }
48 releaseListCmd := &cobra.Command{
49 Use: "list [flags]",
50 Short: `List releases in a repository.`,
51 Long: heredoc.Docf(`
52 By default, lists the releases for the current project, most recent
53 first. Use %[1]s--repo%[1]s to target a different project, or %[1]s-F json%[1]s for
54 machine-readable output.
55 `, "`"),
56 Aliases: []string{"ls"},
57 Args: cobra.NoArgs,
58 ValidArgsFunction: cobra.NoFileCompletions,
59 Example: heredoc.Doc(`
60 glab release list
61 glab release list --per-page 50
62 glab release list -R owner/repository
63 glab release list -F json`),
64 Annotations: map[string]string{
65 mcpannotations.Safe: "true",
66 },
67 RunE: func(cmd *cobra.Command, args []string) error {
68 return opts.run(cmd)
69 },
70 }
72 releaseListCmd.Flags().IntP("page", "p", 1, "Page number.")
73 releaseListCmd.Flags().IntP("per-page", "P", 30, "Number of items to list per page.")
74 cmdutils.EnableJSONOutput(releaseListCmd, opts.io, &opts.outputFormat)
76 releaseListCmd.Flags().StringP("tag", "t", "", "Filter releases by tag <name>.")
77 // deprecate in favour of the `release view` command
78 _ = releaseListCmd.Flags().MarkDeprecated("tag", "Use `glab release view <tag>` instead.")
80 // make it hidden but still accessible
81 // TODO: completely remove before a major release (v2.0.0+)
82 _ = releaseListCmd.Flags().MarkHidden("tag")
84 return releaseListCmd
87func (o *options) run(cmd *cobra.Command) error {
88 l := &gitlab.ListReleasesOptions{}
90 page, _ := cmd.Flags().GetInt("page")
91 l.Page = int64(page)
92 perPage, _ := cmd.Flags().GetInt("per-page")
93 l.PerPage = int64(perPage)
95 tag, err := cmd.Flags().GetString("tag")
96 if err != nil {
97 return err
98 }
100 client, err := o.gitlabClient()
101 if err != nil {
102 return err
103 }
105 repo, err := o.baseRepo()
106 if err != nil {
107 return err
108 }
110 if tag != "" {
111 release, err := getRelease(client, repo.FullName(), tag)
112 if err != nil {
113 return err
114 }
116 if o.outputFormat == "json" {
117 return o.io.PrintJSON(release)
118 }
120 cfg := o.config()
121 glamourStyle, _ := cfg.Get(repo.RepoHost(), "glamour_style")
122 o.io.ResolveBackgroundColor(glamourStyle)
124 err = o.io.StartPager()
125 if err != nil {
126 return err
127 }
128 defer o.io.StopPager()
130 o.io.LogInfo(releaseutils.DisplayRelease(o.io, release, repo))
131 } else {
133 releases, resp, err := listReleases(client, repo.FullName(), l)
134 if err != nil {
135 return err
136 }
138 if o.outputFormat == "json" {
139 return o.io.PrintJSON(releases)
140 }
142 title := utils.NewListTitle("release")
143 title.RepoName = repo.FullName()
144 title.Page = 0
145 title.CurrentPageTotal = len(releases)
146 if resp != nil {
147 title.Total = int(resp.TotalItems)
148 }
149 err = o.io.StartPager()
150 if err != nil {
151 return err
152 }
153 defer o.io.StopPager()
155 o.io.LogInfof("%s\n%s\n", title.Describe(), releaseutils.DisplayAllReleases(o.io, releases, repo.FullName()))
156 }
157 return nil
Diagnostics8 git calls · 210 ms
CallStatusSizeTime0210 ms
discover200185 B3 ms
git.upload-pack discover
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=3
git.response.bytes=185
git.server.agent=git/2.56.g1891de4-Linux
git.server.object_format=sha1
git.server.caps=agent ls-refs fetch server-option object-format
git.server.fetch=shallow wait-for-done filter
git.protocol.version=2
git.pkt.frames=9
git.pkt.data=7
git.pkt.flush=2
git.pkt.delim=0
git.pkt.bytes=185
git.pkt.payload.max=35
ls-refs20058 KiB · hit3 ms
git.upload-pack ls-refs
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=ls-refs
git.upstream.dur_ms=3
git.response.bytes=59849
git.response.cache=HIT
git.response.duration_ms=3
git.protocol.version=2
git.pkt.frames=731
git.pkt.data=730
git.pkt.flush=1
git.pkt.delim=0
git.pkt.bytes=59849
git.pkt.payload.max=143
git.ls_refs.count=730
git.ls_refs.head=refs/heads/main
fetchcombine:blob:none+tree:2 · deepen 12004.2 KiB · hit2 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=2
git.response.bytes=4273
git.response.cache=HIT
git.response.duration_ms=2
git.fetch.filter=combine:blob:none+tree:2
git.fetch.wants=0dd7574dce9e385c5c30540e6c15657adc6bdce9
git.fetch.haves.count=0
git.fetch.deepen=1
git.fetch.thin_pack=false
git.fetch.ofs_delta=true
git.protocol.version=2
git.pkt.frames=7
git.pkt.data=5
git.pkt.flush=1
git.pkt.delim=1
git.pkt.bytes=4273
git.pkt.payload.max=4173
git.sideband.band1.bytes=4173
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0
git.pack.objects=11
git.pack.bytes=4173
git.fetch.wide.objects=11
git.fetch.wide.extra_bytes=3930
git.fetch.wide.blobs=0
fetchtree:0 · deepen 1020032 KiB · hit3 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=3
git.response.bytes=32926
git.response.cache=HIT
git.response.duration_ms=3
git.fetch.filter=tree:0
git.fetch.wants=0dd7574dce9e385c5c30540e6c15657adc6bdce9
git.fetch.haves.count=0
git.fetch.deepen=10
git.fetch.thin_pack=false
git.fetch.ofs_delta=true
git.protocol.version=2
git.pkt.frames=22
git.pkt.data=20
git.pkt.flush=1
git.pkt.delim=1
git.pkt.bytes=32926
git.pkt.payload.max=32046
git.sideband.band1.bytes=32046
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0
git.pack.objects=80
git.pack.bytes=32046
git.pack.ofs_delta=36
git.pack.ref_delta=0
git.pack.chain.max=2
git.pack.trailer=cb0bad5d7ffc514895d8b21c4dd470327f90bc91
git.pack.full=44
Open pack map
fetchtree:02001.8 KiB · hit3 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=3
git.response.bytes=1857
git.response.cache=HIT
git.response.duration_ms=3
git.fetch.filter=tree:0
git.fetch.wants=dce174ff8c632a19d17eea99c8a9b7c37fb2b592
git.fetch.haves.count=0
git.fetch.deepen=0
git.fetch.thin_pack=false
git.fetch.ofs_delta=true
git.protocol.version=2
git.pkt.frames=4
git.pkt.data=3
git.pkt.flush=1
git.pkt.delim=0
git.pkt.bytes=1857
git.pkt.payload.max=1830
git.sideband.band1.bytes=1830
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0
git.pack.objects=1
git.pack.bytes=1830
git.pack.trailer=fb03183b7909876778f740d196d7516811003517
Open pack map
fetchtree:0200350 B · hit3 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=3
git.response.bytes=350
git.response.cache=HIT
git.response.duration_ms=3
git.fetch.filter=tree:0
git.fetch.wants=b2a837e646ba305993f35203fafafb109e57a7ca
git.fetch.haves.count=0
git.fetch.deepen=0
git.fetch.thin_pack=false
git.fetch.ofs_delta=true
git.protocol.version=2
git.pkt.frames=4
git.pkt.data=3
git.pkt.flush=1
git.pkt.delim=0
git.pkt.bytes=350
git.pkt.payload.max=323
git.sideband.band1.bytes=323
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0
git.pack.objects=1
git.pack.bytes=323
git.pack.trailer=1232131042f2ba4c9c4dbd99382667a1f0849e15
Open pack map
fetchtree:0200142 B · hit3 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=196
git.response.bytes=142
git.response.cache=HIT
git.response.duration_ms=3
git.fetch.filter=tree:0
git.fetch.wants=c961dd4b66b0ecad8dfb3fe25c3e67c349274d62
git.fetch.haves.count=0
git.fetch.deepen=0
git.fetch.thin_pack=false
git.fetch.ofs_delta=true
git.protocol.version=2
git.pkt.frames=4
git.pkt.data=3
git.pkt.flush=1
git.pkt.delim=0
git.pkt.bytes=142
git.pkt.payload.max=115
git.sideband.band1.bytes=115
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0
git.pack.objects=1
git.pack.bytes=115
git.pack.trailer=d9c0e09d50b35c9f3e658a20b69f00ed7ba0a6fe
Open pack map
fetch2001.6 KiB196 ms
git.upload-pack fetch
http.response.status_code=200
git.response.bytes=1610
git.response.cache=MISS
git.response.duration_ms=196
git.fetch.wants=019e2f77cf9956ece70178d594bf3f5036a47260
git.fetch.haves.count=0
git.fetch.deepen=0
git.fetch.thin_pack=false
git.fetch.ofs_delta=true
git.protocol.version=2
git.pkt.frames=4
git.pkt.data=3
git.pkt.flush=1
git.pkt.delim=0
git.pkt.bytes=1610
git.pkt.payload.max=1583
git.sideband.band1.bytes=1583
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0

Each row is one HTTP round trip ply made to the git server for this page, on one timeline. discover asks what the server speaks, ls-refs lists branch tips, fetch brings objects by id. A hit was served by Workers Cache. Tap a row for its wire details.

Remote
https://gitlab.com/gitlab-org/cli
Ref
refs/heads/main
Commit
0dd7574dce9e385c5c30540e6c15657adc6bdce9
cf-ray
a5e2fbc99afecf81
Request
57492bc4…
Protocol
v2 · sha1
Agent
git/2.56.g1891de4-Linux
Filter
advertised
Fetch
shallow wait-for-done filter
Capabilities
agent ls-refs fetch server-option object-format