GitLabgitlab-org
cli
main
1package job
3import (
4 "fmt"
6 "github.com/MakeNowJust/heredoc/v2"
7 "github.com/spf13/cobra"
8 "github.com/spf13/pflag"
10 gitlab "gitlab.com/gitlab-org/api/client-go/v3"
12 "gitlab.com/gitlab-org/cli/internal/cmdutils"
13 "gitlab.com/gitlab-org/cli/internal/commands/ci/ciutils"
14 "gitlab.com/gitlab-org/cli/internal/glrepo"
15 "gitlab.com/gitlab-org/cli/internal/iostreams"
16 "gitlab.com/gitlab-org/cli/internal/mcpannotations"
17)
19const (
20 FlagDryRun = "dry-run"
21 FlagForce = "force"
22)
24func NewCmdCancel(f cmdutils.Factory) *cobra.Command {
25 jobCancelCmd := &cobra.Command{
26 Use: "job <id> [<id>...] [flags]",
27 Short: `Cancel CI/CD jobs.`,
28 Long: heredoc.Docf(`
29 Cancels one or more running CI/CD jobs by ID. You can pass multiple
30 job IDs as separate arguments, in a comma-separated list, or in a
31 quoted space-separated list.
33 To preview which jobs would be canceled without making changes, use
34 %[1]s--dry-run%[1]s.
36 Use %[1]s--force%[1]s to cancel jobs that are in a protected environment.
37 `, "`"),
38 Example: heredoc.Doc(`
39 # Cancel a single job
40 glab ci cancel job 1504182795
42 # Cancel multiple jobs, comma-separated
43 glab ci cancel job 1504182795,1504182796
45 # Cancel multiple jobs, space-separated in quotes
46 glab ci cancel job "1504182795 1504182796"
48 # Preview which jobs would be canceled
49 glab ci cancel job 1504182795,1504182796 --dry-run
51 # Force-cancel a job in a protected environment
52 glab ci cancel job 1504182795 --force
53 `),
54 Args: func(cmd *cobra.Command, args []string) error {
55 if len(args) < 1 {
56 return fmt.Errorf("you must pass a job ID")
57 }
59 return nil
60 },
61 Annotations: map[string]string{
62 mcpannotations.Destructive: "true",
63 },
64 RunE: func(cmd *cobra.Command, args []string) error {
65 var err error
66 c := f.IO().Color()
67 client, err := f.GitLabClient()
68 if err != nil {
69 return err
70 }
72 repo, err := f.BaseRepo()
73 if err != nil {
74 return err
75 }
76 dryRunMode, _ := cmd.Flags().GetBool(FlagDryRun)
77 forceMode, _ := cmd.Flags().GetBool(FlagForce)
79 var jobIDs []int
81 jobIDs, err = ciutils.IDsFromArgs(args)
82 if err != nil {
83 return err
84 }
85 return runCancelation(f.IO(), jobIDs, dryRunMode, forceMode, c, client, repo)
86 },
87 }
89 SetupCommandFlags(jobCancelCmd.Flags())
90 jobCancelCmd.MarkFlagsMutuallyExclusive(FlagDryRun, FlagForce)
91 return jobCancelCmd
92}
94func SetupCommandFlags(flags *pflag.FlagSet) {
95 flags.BoolP(FlagDryRun, "", false, "Show which jobs would be canceled, without canceling them.")
96 flags.BoolP(FlagForce, "f", false, "Force-cancel the job, even if it runs in a protected environment.")
97}
99func runCancelation(
100 io *iostreams.IOStreams,
101 jobIDs []int,
102 dryRunMode bool,
103 forceMode bool,
104 c *iostreams.ColorPalette,
105 apiClient *gitlab.Client,
106 repo glrepo.Interface,
107) error {
108 for _, id := range jobIDs {
109 if dryRunMode {
110 io.LogInfof("%s Job #%d will be canceled.\n", c.DotWarnIcon(), id)
111 } else {
112 pid, err := repo.Project(apiClient)
113 if err != nil {
114 return err
115 }
116 if forceMode {
117 //nolint:staticcheck // CancelJobWithOptions is the only way to pass force in SDK v2; options merge into CancelJob in v4.
118 _, _, err = apiClient.Jobs.CancelJobWithOptions(pid.ID, int64(id), &gitlab.CancelJobOptions{
119 Force: new(true),
120 })
121 } else {
122 _, _, err = apiClient.Jobs.CancelJob(pid.ID, int64(id))
123 }
124 if err != nil {
125 return err
126 }
128 io.LogInfof("%s Job #%d is canceled successfully.\n", c.RedCheck(), id)
129 }
130 }
131 fmt.Println()
133 return nil
134}
Diagnostics9 git calls · 466 ms
CallStatusSizeTime0466 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 KiB192 ms
git.upload-pack ls-refs http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=ls-refs git.upstream.dur_ms=173 git.response.bytes=59849 git.response.cache=EXPIRED git.response.duration_ms=192 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
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
fetchcombine:blob:none+tree:2 · deepen 12004.2 KiB · hit4 ms
git.upload-pack fetch http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=fetch git.upstream.dur_ms=4 git.response.bytes=4273 git.response.cache=HIT git.response.duration_ms=4 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: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=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=2 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:0200200 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=200 git.response.cache=HIT git.response.duration_ms=3 git.fetch.filter=tree:0 git.fetch.wants=09cfbad46fa4ba4ecbbcdaa67b2ec60fcea9d2a5 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=200 git.pkt.payload.max=173 git.sideband.band1.bytes=173 git.sideband.band2.bytes=0 git.sideband.band3.bytes=0 git.pack.objects=1 git.pack.bytes=173 git.pack.trailer=501b1d5b3685ca8af17dae7e4719f637e08db63fOpen pack map
fetchtree:0200135 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=135 git.response.cache=HIT git.response.duration_ms=2 git.fetch.filter=tree:0 git.fetch.wants=ad01086a18463a5477850700f49114cd4808bfc5 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=135 git.pkt.payload.max=108 git.sideband.band1.bytes=108 git.sideband.band2.bytes=0 git.sideband.band3.bytes=0 git.pack.objects=1 git.pack.bytes=108 git.pack.trailer=ba84a0da7767bb24292cf35db1885882d7c2c251Open pack map
fetch2001.4 KiB260 ms
git.upload-pack fetch http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=fetch git.upstream.dur_ms=260 git.response.bytes=1465 git.response.cache=MISS git.response.duration_ms=260 git.fetch.wants=fd7c768a2dfbf0f36ae8b6055b3b911db5a4b1ff 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=1465 git.pkt.payload.max=1438 git.sideband.band1.bytes=1438 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
- a5e361031f97b86e
- Request
- 55906eb7…
- 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