GitLabgitlab-org

cli

main
ply7 git calls38 ms99 KiB5 cachedprotocol v2
91 lines4.4 KiBRaw

Update a merge request.

Synopsis

Defaults to the currently checked-out branch. Use --fill to automatically fill the title and description from the commit history.

--attach uploads a file and references it at the end of the description. Repeat the flag for more than one file, or pass - to read the file from standard input. Without --description the references are added to the description the merge request already has, instead of replacing it.

The --attach flag is an experiment. It might be unstable or removed at any time, and is not ready for production use. For more information, see https://docs.gitlab.com/policy/development_stages_support/.

plaintext
glab mr update [<id> | <branch>] [flags]

Examples

console
# Mark a merge request as ready
glab mr update 23 --ready

# Mark a merge request as draft
glab mr update 23 --draft

# Updates the merge request for the current branch
glab mr update --draft

# Select the open merge request when a branch also has merged requests
glab mr update feature-branch --state opened --ready

# Update merge request with commit information
glab mr update 23 --fill --fill-commit-body --yes

# Read the description from a file
glab mr update 23 --description-file description.md

# Read the description from standard input
cat description.md | glab mr update 23 --description-file -

# Add a screenshot to the existing description
glab mr update 23 --attach ./screenshot.png

Options

plaintext
  -a, --assignee strings          Assign users via username. Prefix with '!' or '-' to remove from existing assignees, '+' to add. Otherwise, replace existing assignees with given users. Multiple usernames can be comma-separated or specified by repeating the flag.
      --attach stringArray        (EXPERIMENTAL) Upload a file and reference it at the end of the description. Use "-" to read the file from standard input. Repeat the flag to attach multiple files.
  -d, --description string        Merge request description. Set to "-" to open an editor.
      --description-file string   Read the merge request description from a file. Use "-" to read from standard input.
      --draft                     Mark merge request as a draft.
  -f, --fill                      Do not prompt for title or body, and just use commit info.
      --fill-commit-body          Fill body with each commit body when multiple commits. Can only be used with --fill.
  -l, --label strings             Add labels.
      --lock-discussion           Lock discussion on merge request.
  -m, --milestone string          Title of the milestone to assign. Set to "" or 0 to unassign.
  -r, --ready                     Mark merge request as ready to be reviewed and merged.
      --remove-source-branch      Toggles the removal of the source branch on merge.
      --reviewer strings          Request review from users by their usernames. Prefix with '!' or '-' to remove from existing reviewers, '+' to add. Otherwise, replace existing reviewers with given users. Multiple usernames can be comma-separated or specified by repeating the flag.
      --squash-before-merge       Toggles the option to squash commits into a single commit when merging.
      --state string              Filter by state when selecting a merge request by branch: opened, closed, merged, locked, any. Ignored for IDs and URLs. (default "any")
      --target-branch string      Set target branch.
  -t, --title string              Title of merge request.
      --unassign                  Unassign all users.
  -u, --unlabel strings           Remove labels.
      --unlock-discussion         Unlock discussion on merge request.
      --wip                       Mark merge request as a work in progress. Alternative to --draft.
  -y, --yes                       Skip confirmation prompt.

Options inherited from parent commands

plaintext
  -h, --help          Show help for this command.
  -R, --repo string   Select another repository. You can use either OWNER/REPO or GROUP/NAMESPACE/REPO. The full URL or Git URL is also accepted.
1---
2title: '`glab mr update`'
3stage: AI Clients
4group: Developer Clients
5info: To determine the technical writer assigned to the Stage/Group associated with this page, see <https://handbook.gitlab.com/handbook/marketing/product-and-technical-marketing/technical-writing/#assignments>
6---
8<!--
9This documentation is auto generated by a script.
10Please do not edit this file directly. Run `make gen-docs` instead.
11-->
13Update a merge request.
15## Synopsis
17Defaults to the currently checked-out branch. Use `--fill` to
18automatically fill the title and description from the commit history.
20`--attach` uploads a file and references it at the end of the description. Repeat the flag for more than one file, or pass `-` to read the file from standard input. Without `--description` the references are added to the description the merge request already has, instead of replacing it.
22The `--attach` flag is an experiment. It might be
23unstable or removed at any time, and is not ready for production use.
24For more information, see
25<https://docs.gitlab.com/policy/development_stages_support/>.
27```plaintext
28glab mr update [<id> | <branch>] [flags]
29```
31## Examples
33```console
34# Mark a merge request as ready
35glab mr update 23 --ready
37# Mark a merge request as draft
38glab mr update 23 --draft
40# Updates the merge request for the current branch
41glab mr update --draft
43# Select the open merge request when a branch also has merged requests
44glab mr update feature-branch --state opened --ready
46# Update merge request with commit information
47glab mr update 23 --fill --fill-commit-body --yes
49# Read the description from a file
50glab mr update 23 --description-file description.md
52# Read the description from standard input
53cat description.md | glab mr update 23 --description-file -
55# Add a screenshot to the existing description
56glab mr update 23 --attach ./screenshot.png
57```
59## Options
61```plaintext
62 -a, --assignee strings Assign users via username. Prefix with '!' or '-' to remove from existing assignees, '+' to add. Otherwise, replace existing assignees with given users. Multiple usernames can be comma-separated or specified by repeating the flag.
63 --attach stringArray (EXPERIMENTAL) Upload a file and reference it at the end of the description. Use "-" to read the file from standard input. Repeat the flag to attach multiple files.
64 -d, --description string Merge request description. Set to "-" to open an editor.
65 --description-file string Read the merge request description from a file. Use "-" to read from standard input.
66 --draft Mark merge request as a draft.
67 -f, --fill Do not prompt for title or body, and just use commit info.
68 --fill-commit-body Fill body with each commit body when multiple commits. Can only be used with --fill.
69 -l, --label strings Add labels.
70 --lock-discussion Lock discussion on merge request.
71 -m, --milestone string Title of the milestone to assign. Set to "" or 0 to unassign.
72 -r, --ready Mark merge request as ready to be reviewed and merged.
73 --remove-source-branch Toggles the removal of the source branch on merge.
74 --reviewer strings Request review from users by their usernames. Prefix with '!' or '-' to remove from existing reviewers, '+' to add. Otherwise, replace existing reviewers with given users. Multiple usernames can be comma-separated or specified by repeating the flag.
75 --squash-before-merge Toggles the option to squash commits into a single commit when merging.
76 --state string Filter by state when selecting a merge request by branch: opened, closed, merged, locked, any. Ignored for IDs and URLs. (default "any")
77 --target-branch string Set target branch.
78 -t, --title string Title of merge request.
79 --unassign Unassign all users.
80 -u, --unlabel strings Remove labels.
81 --unlock-discussion Unlock discussion on merge request.
82 --wip Mark merge request as a work in progress. Alternative to --draft.
83 -y, --yes Skip confirmation prompt.
84```
86## Options inherited from parent commands
88```plaintext
89 -h, --help Show help for this command.
90 -R, --repo string Select another repository. You can use either OWNER/REPO or GROUP/NAMESPACE/REPO. The full URL or Git URL is also accepted.
91```
Diagnostics7 git calls · 38 ms
CallStatusSizeTime038 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 KiB7 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=UPDATING
git.response.duration_ms=7
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 · hit5 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=5
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.7 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=1744
git.response.cache=HIT
git.response.duration_ms=4
git.fetch.filter=tree:0
git.fetch.wants=5e4007a5673eb3bf5d0d7f1a1463c3b2ca3fb3bd
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=1744
git.pkt.payload.max=1717
git.sideband.band1.bytes=1717
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0
git.pack.objects=1
git.pack.bytes=1717
git.pack.trailer=3f1b9ccc7756e8941d6705e8187c87fd922113e6
Open pack map
fetchtree:0200669 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=669
git.response.cache=HIT
git.response.duration_ms=2
git.fetch.filter=tree:0
git.fetch.wants=e7f366ff56d25d838386e3ceead4278af75f7180
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=669
git.pkt.payload.max=642
git.sideband.band1.bytes=642
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0
git.pack.objects=1
git.pack.bytes=642
git.pack.trailer=8973f4a733afcd554e109d2cd1877fb7b7210224
Open pack map
fetch2001.7 KiB · hit22 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=22
git.response.bytes=1767
git.response.cache=HIT
git.response.duration_ms=22
git.fetch.wants=1cacf99ed5fcb6f1edb374fa3d008ecd0cee4158
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=1767
git.pkt.payload.max=1740
git.sideband.band1.bytes=1740
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
a5e15e6bb912cf6a
Request
181ded9c…
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