GitLabgitlab-org
cli
main
1package contributors
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/glrepo"
11 "gitlab.com/gitlab-org/cli/internal/iostreams"
12 "gitlab.com/gitlab-org/cli/internal/mcpannotations"
13 "gitlab.com/gitlab-org/cli/internal/tableprinter"
14 "gitlab.com/gitlab-org/cli/internal/utils"
15)
17type options struct {
18 orderBy string
19 sort string
20 perPage int
21 page int
22 outputFormat string
24 baseRepo func() (glrepo.Interface, error)
25 gitlabClient func() (*gitlab.Client, error)
26 io *iostreams.IOStreams
27}
29func NewCmdContributors(f cmdutils.Factory) *cobra.Command {
30 opts := &options{
31 io: f.IO(),
32 baseRepo: f.BaseRepo,
33 gitlabClient: f.GitLabClient,
34 }
35 repoContributorsCmd := &cobra.Command{
36 Use: "contributors",
37 Short: `Get repository contributors list.`,
38 Long: heredoc.Docf(`
39 Lists the users who have contributed commits to the repository, with
40 each contributor's commit count. Use %[1]s--repo%[1]s to target a different
41 repository.
42 `, "`"),
43 Example: heredoc.Doc(`
44 # List contributors for the current repository
45 glab repo contributors
47 # List contributors for a specific repository
48 glab repo contributors -R gitlab-com/www-gitlab-com`),
49 Args: cobra.NoArgs,
50 ValidArgsFunction: cobra.NoFileCompletions,
51 Aliases: []string{"users"},
52 Annotations: map[string]string{
53 mcpannotations.Safe: "true",
54 },
55 RunE: func(cmd *cobra.Command, args []string) error {
56 return opts.run()
57 },
58 }
60 cmdutils.EnableRepoOverride(repoContributorsCmd, f)
62 repoContributorsCmd.Flags().StringVarP(&opts.orderBy, "order", "o", "commits", "Return contributors ordered by name, email, or commits (orders by commit date) fields.")
63 repoContributorsCmd.Flags().StringVarP(&opts.sort, "sort", "s", "", "Sort direction for --order field: asc or desc.")
64 repoContributorsCmd.Flags().IntVarP(&opts.page, "page", "p", 1, "Page number.")
65 repoContributorsCmd.Flags().IntVarP(&opts.perPage, "per-page", "P", 30, "Number of items to list per page.")
66 cmdutils.EnableJSONOutput(repoContributorsCmd, opts.io, &opts.outputFormat)
67 return repoContributorsCmd
68}
70func (o *options) run() error {
71 var err error
72 c := o.io.Color()
74 client, err := o.gitlabClient()
75 if err != nil {
76 return err
77 }
79 repo, err := o.baseRepo()
80 if err != nil {
81 return err
82 }
84 if o.orderBy == "commits" && o.sort == "" {
85 o.sort = "desc"
86 }
88 l := &gitlab.ListContributorsOptions{
89 OrderBy: new(o.orderBy),
90 ListOptions: gitlab.ListOptions{
91 Page: int64(o.page),
92 PerPage: int64(o.perPage),
93 },
94 }
96 if o.sort != "" {
97 l.Sort = new(o.sort)
98 }
100 users, resp, err := client.Repositories.Contributors(repo.FullName(), l)
101 if err != nil {
102 return err
103 }
105 if o.outputFormat == "json" {
106 return o.io.PrintJSON(users)
107 }
109 // Title
110 title := utils.NewListTitle("contributor")
111 title.RepoName = repo.FullName()
112 title.Page = int(l.Page)
113 title.CurrentPageTotal = len(users)
114 if resp != nil {
115 title.Total = int(resp.TotalItems)
116 }
118 // List
119 table := tableprinter.NewTablePrinter()
120 for _, user := range users {
121 table.AddCell(user.Name)
122 table.AddCellf("%s", c.Gray(user.Email))
123 table.AddCellf("%d commits", user.Commits)
124 table.EndRow()
125 }
127 o.io.LogInfof("%s\n%s\n", title.Describe(), table.String())
128 return err
129}
Diagnostics8 git calls · 211 ms
CallStatusSizeTime0211 ms
discover200185 B3 ms
git.upload-pack discover http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=ls-refs 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=3 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=2 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=44Open pack map
fetchtree:02001.8 KiB · hit1 ms
git.upload-pack fetch http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=fetch git.upstream.dur_ms=1 git.response.bytes=1857 git.response.cache=HIT git.response.duration_ms=1 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=fb03183b7909876778f740d196d7516811003517Open pack map
fetchtree:0200614 B · 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=614 git.response.cache=HIT git.response.duration_ms=2 git.fetch.filter=tree:0 git.fetch.wants=3a89d0cfc8e81880c982180388e42e561a0b7eee 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=614 git.pkt.payload.max=587 git.sideband.band1.bytes=587 git.sideband.band2.bytes=0 git.sideband.band3.bytes=0 git.pack.objects=1 git.pack.bytes=587 git.pack.trailer=eb8250f8e8340ff2fafc22c5aba90db34fd906a9Open pack map
fetchtree:0200181 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=181 git.response.cache=HIT git.response.duration_ms=3 git.fetch.filter=tree:0 git.fetch.wants=7d236f774db2ac22426ffebf5d3fa5d8bb51a194 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=181 git.pkt.payload.max=154 git.sideband.band1.bytes=154 git.sideband.band2.bytes=0 git.sideband.band3.bytes=0 git.pack.objects=1 git.pack.bytes=154 git.pack.trailer=b725d8caa8c248b36e45a3f71d9b47301c14bcfcOpen pack map
fetch2001.4 KiB200 ms
git.upload-pack fetch http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=fetch git.upstream.dur_ms=200 git.response.bytes=1438 git.response.cache=MISS git.response.duration_ms=200 git.fetch.wants=64645eeb786d041001bdfb2930dac5cf7d218dd5 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=1438 git.pkt.payload.max=1411 git.sideband.band1.bytes=1411 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
- a5ea56afbccc7089
- Request
- 4273ada8…
- 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