GitLabgitlab-org

cli

main
ply9 git calls222 ms99 KiB7 cachedprotocol v2
113 lines2.8 KiBRaw
1package compile
3import (
4 "fmt"
5 "os"
6 "strings"
8 "github.com/MakeNowJust/heredoc/v2"
9 "github.com/spf13/cobra"
11 gitlab "gitlab.com/gitlab-org/api/client-go/v3"
13 "gitlab.com/gitlab-org/cli/internal/api"
14 "gitlab.com/gitlab-org/cli/internal/cmdutils"
15 "gitlab.com/gitlab-org/cli/internal/mcpannotations"
18func NewCmdConfigCompile(f cmdutils.Factory) *cobra.Command {
19 configCompileCmd := &cobra.Command{
20 Use: "compile [<path>]",
21 Short: "View the merged CI/CD configuration.",
22 Long: heredoc.Docf(`
23 Compiles your CI/CD configuration and prints the fully merged YAML
24 to standard output.
26 All %[1]sinclude%[1]s directives are resolved,
27 and any extended jobs are flattened into their final form.
29 By default, glab compiles the %[1]s.gitlab-ci.yml%[1]s file in the
30 current directory. To compile a different file, pass its path as an
31 argument.
33 You must run this command from a GitLab project repository.
34 `, "`"),
35 Args: cobra.MaximumNArgs(1),
36 Example: heredoc.Doc(`
37 # Compile .gitlab-ci.yml in the current directory
38 glab ci config compile
40 # Compile a specific file in the current directory
41 glab ci config compile .gitlab-ci.yml
43 # Compile a file at a relative path
44 glab ci config compile path/to/.gitlab-ci.yml
45 `),
46 Annotations: map[string]string{
47 mcpannotations.Safe: "true",
48 },
49 RunE: func(cmd *cobra.Command, args []string) error {
50 path := ".gitlab-ci.yml"
51 if len(args) == 1 {
52 path = args[0]
53 }
54 return compileRun(f, path)
55 },
56 }
58 configCompileCmd.SetHelpFunc(func(command *cobra.Command, strings []string) {
59 // Hide "repo"-flag for this command, because it cannot be used on repositories but only on gitlab-ci files
60 _ = configCompileCmd.Flags().MarkHidden("repo")
62 configCompileCmd.Parent().HelpFunc()(command, strings)
63 })
65 return configCompileCmd
68func compileRun(f cmdutils.Factory, path string) error {
69 var err error
71 client, err := f.GitLabClient()
72 if err != nil {
73 return err
74 }
76 repo, err := f.BaseRepo()
77 if err != nil {
78 return fmt.Errorf("you must be in a GitLab project repository for this action: %w", err)
79 }
81 project, err := repo.Project(client)
82 if err != nil {
83 return fmt.Errorf("you must be in a GitLab project repository for this action: %w", err)
84 }
86 content, err := os.ReadFile(path)
87 if err != nil {
88 return fmt.Errorf("reading CI/CD configuration at %s: %w", path, err)
89 }
91 compiledResult, _, err := client.Validate.ProjectNamespaceLint(
92 project.ID,
93 &gitlab.ProjectNamespaceLintOptions{
94 Content: new(string(content)),
95 DryRun: new(bool),
96 Ref: new(string),
97 IncludeJobs: new(bool),
98 },
99 api.WithSafeRetries(),
100 )
101 if err != nil {
102 return err
103 }
105 if !compiledResult.Valid {
106 errorsStr := strings.Join(compiledResult.Errors, ", ")
107 return fmt.Errorf("could not compile %s: %s", path, errorsStr)
108 }
110 fmt.Print(compiledResult.MergedYaml)
112 return nil
Diagnostics9 git calls · 222 ms
CallStatusSizeTime0222 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 · 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=4273
git.response.cache=HIT
git.response.duration_ms=3
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 · 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=fb03183b7909876778f740d196d7516811003517
Open pack map
fetchtree:0200635 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=635
git.response.cache=HIT
git.response.duration_ms=3
git.fetch.filter=tree:0
git.fetch.wants=517b073a0d5c32bc4e93f86de74b31d60ff8cf03
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=635
git.pkt.payload.max=608
git.sideband.band1.bytes=608
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0
git.pack.objects=1
git.pack.bytes=608
git.pack.trailer=178abb9456d874b7fd38fa21ad5cf9ca3ebcccaa
Open pack map
fetchtree:0200143 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=143
git.response.cache=HIT
git.response.duration_ms=3
git.fetch.filter=tree:0
git.fetch.wants=ee5f8c756c8c020c62c59905e8f39da74022b254
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=143
git.pkt.payload.max=116
git.sideband.band1.bytes=116
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0
git.pack.objects=1
git.pack.bytes=116
git.pack.trailer=b606b64af33378cfa4c346b6d8c45495a9b77645
Open pack map
fetchtree:0200139 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=139
git.response.cache=HIT
git.response.duration_ms=2
git.fetch.filter=tree:0
git.fetch.wants=20f94aaf5df3849bcc2e599e44cad14ba3265463
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=139
git.pkt.payload.max=112
git.sideband.band1.bytes=112
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0
git.pack.objects=1
git.pack.bytes=112
git.pack.trailer=8fc5ad9539e15b0c6f40ee31063861ad475050aa
Open pack map
fetch2001.2 KiB207 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=207
git.response.bytes=1268
git.response.cache=MISS
git.response.duration_ms=207
git.fetch.wants=8f8ba0902959eab9fc0a87434c024d9dac13627c
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=1268
git.pkt.payload.max=1241
git.sideband.band1.bytes=1241
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
a5e2f3c879237089
Request
685c99d5…
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