GitLabgitlab-org
cli
main
1package lint
3import (
4 "bytes"
5 "context"
6 "fmt"
7 "io"
8 "net/http"
9 "os"
11 "github.com/MakeNowJust/heredoc/v2"
12 "github.com/spf13/cobra"
14 gitlab "gitlab.com/gitlab-org/api/client-go/v3"
16 "gitlab.com/gitlab-org/cli/internal/api"
17 "gitlab.com/gitlab-org/cli/internal/cmdutils"
18 "gitlab.com/gitlab-org/cli/internal/git"
19 "gitlab.com/gitlab-org/cli/internal/glrepo"
20 "gitlab.com/gitlab-org/cli/internal/iostreams"
21 "gitlab.com/gitlab-org/cli/internal/mcpannotations"
22)
24type options struct {
25 io *iostreams.IOStreams
26 gitlabClient func() (*gitlab.Client, error)
27 baseRepo func() (glrepo.Interface, error)
29 path string
30 ref string
31 dryRun bool
32 includeJobs bool
33}
35func NewCmdLint(f cmdutils.Factory) *cobra.Command {
36 opts := options{
37 io: f.IO(),
38 gitlabClient: f.GitLabClient,
39 baseRepo: f.BaseRepo,
40 }
41 pipelineCILintCmd := &cobra.Command{
42 Use: "lint",
43 Short: "Check if your `.gitlab-ci.yml` file is valid.",
44 Long: heredoc.Docf(`
45 Defaults to the %[1]s.gitlab-ci.yml%[1]s file in the current directory.
46 You can also pass a URL to validate a remote file. Use %[1]s--dry-run%[1]s
47 to simulate pipeline creation, and %[1]s--ref%[1]s to set the branch or
48 tag context for the simulation.
49 `, "`"),
50 Args: cobra.MaximumNArgs(1),
51 Example: heredoc.Doc(`
52 # Uses .gitlab-ci.yml in the current directory
53 glab ci lint
55 # Lint a specific file
56 glab ci lint .gitlab-ci.yml
57 glab ci lint path/to/.gitlab-ci.yml`),
58 Annotations: map[string]string{
59 mcpannotations.Safe: "true",
60 },
61 RunE: func(cmd *cobra.Command, args []string) error {
62 opts.complete(args)
63 return opts.run(cmd.Context())
64 },
65 }
67 pipelineCILintCmd.Flags().BoolVarP(&opts.dryRun, "dry-run", "", false, "Run pipeline creation simulation.")
68 pipelineCILintCmd.Flags().BoolVarP(&opts.includeJobs, "include-jobs", "", false, "Include the list of jobs that would exist in a static check or pipeline simulation.")
69 pipelineCILintCmd.Flags().StringVar(&opts.ref, "ref", "", "When '--dry-run' is true, sets the branch or tag context for validating the CI/CD YAML configuration.")
71 return pipelineCILintCmd
72}
74func (o *options) complete(args []string) {
75 if len(args) == 1 {
76 o.path = args[0]
77 } else {
78 o.path = ".gitlab-ci.yml"
79 }
80}
82func (o *options) run(ctx context.Context) error {
83 var err error
84 c := o.io.Color()
86 client, err := o.gitlabClient()
87 if err != nil {
88 return err
89 }
91 repo, err := o.baseRepo()
92 if err != nil {
93 return fmt.Errorf("you must be in a GitLab project repository for this action: %w", err)
94 }
96 project, err := repo.Project(client)
97 if err != nil {
98 return fmt.Errorf("you must be in a GitLab project repository for this action: %w", err)
99 }
101 projectID := project.ID
103 var content []byte
104 var stdout bytes.Buffer
106 if git.IsValidURL(o.path) {
107 req, err := http.NewRequestWithContext(ctx, http.MethodGet, o.path, http.NoBody)
108 if err != nil {
109 return err
110 }
111 resp, err := http.DefaultClient.Do(req)
112 if err != nil {
113 return err
114 }
115 defer resp.Body.Close()
116 if resp.StatusCode < http.StatusOK || resp.StatusCode >= http.StatusMultipleChoices {
117 return fmt.Errorf("fetching %s: %s", o.path, resp.Status)
118 }
119 _, err = io.Copy(&stdout, resp.Body)
120 if err != nil {
121 return err
122 }
123 content = stdout.Bytes()
124 } else {
125 content, err = os.ReadFile(o.path)
126 if err != nil {
127 if os.IsNotExist(err) {
128 return fmt.Errorf("%s: no such file or directory", o.path)
129 }
130 return err
131 }
132 }
134 o.io.LogInfo("Validating...")
136 lintOpts := &gitlab.ProjectNamespaceLintOptions{
137 Content: new(string(content)),
138 DryRun: new(o.dryRun),
139 IncludeJobs: new(o.includeJobs),
140 }
141 // Only include Ref if it was explicitly set by the user
142 if o.ref != "" {
143 lintOpts.Ref = new(o.ref)
144 }
146 lint, _, err := client.Validate.ProjectNamespaceLint(
147 projectID,
148 lintOpts,
149 api.WithSafeRetries(),
150 )
151 if err != nil {
152 return err
153 }
155 if !lint.Valid {
156 o.io.LogInfo(c.Red(o.path + " is invalid."))
157 for i, err := range lint.Errors {
158 i++
159 o.io.LogInfo(i, err)
160 }
161 return cmdutils.SilentError
162 }
163 o.io.LogInfo(c.GreenCheck(), "CI/CD YAML is valid!")
164 return nil
165}
Diagnostics8 git calls · 214 ms
CallStatusSizeTime0214 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=2 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 · 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=32926 git.response.cache=HIT git.response.duration_ms=2 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 · 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=1857 git.response.cache=HIT git.response.duration_ms=2 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:0200635 B · 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=635 git.response.cache=HIT git.response.duration_ms=2 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=178abb9456d874b7fd38fa21ad5cf9ca3ebcccaaOpen pack map
fetchtree:0200206 B · hit3 ms
git.upload-pack fetch http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=fetch git.upstream.dur_ms=202 git.response.bytes=206 git.response.cache=HIT git.response.duration_ms=3 git.fetch.filter=tree:0 git.fetch.wants=cb4b42d99ca4351b5bc7d4917ed3d8ae0dc5408d 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=206 git.pkt.payload.max=179 git.sideband.band1.bytes=179 git.sideband.band2.bytes=0 git.sideband.band3.bytes=0 git.pack.objects=1 git.pack.bytes=179 git.pack.trailer=a90388371338c04e45a95e8062f0a7c706f2c6bbOpen pack map
fetch2001.7 KiB202 ms
git.upload-pack fetch http.response.status_code=200 git.response.bytes=1740 git.response.cache=MISS git.response.duration_ms=202 git.fetch.wants=0999979e848bf12c8d310df42f8d84d8762b7c5d 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=1740 git.pkt.payload.max=1713 git.sideband.band1.bytes=1713 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
- a5e2e6a06d66ecfa
- Request
- 2b29d1b5…
- 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