GitLabgitlab-org

cli

main
ply8 git calls292 ms99 KiB5 cachedprotocol v2
67 lines2.6 KiBRaw

Update the body of a note on a merge request. (EXPERIMENTAL)

Synopsis

Replace the body of an existing note on a merge request.

<note-id> is a numeric note ID, not a hex discussion ID. You can find note IDs with:

  • glab mr note list -F json (the .id field)
  • Note URLs: .../merge_requests/1#note_12345

You can change only the note body. You cannot move the position of diff notes.

--attach uploads a file and references it at the end of the note. Repeat the flag for more than one file, or pass - to read the file from standard input. Without --message, standard input that is not a terminal is read as the new body. It replaces the existing body, unless --attach - reads the file from standard input. With neither --message nor piped input, the references are added to the body the note already has, instead of replacing it. The command waits until standard input closes, so to keep the existing body from a script, redirect standard input from /dev/null.

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

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

Examples

console
# Update note 12345 on merge request 1 with a new message
glab mr note update 1 12345 -m "Updated comment"

# Update a note on the current branch's merge request, composing in an editor
glab mr note update 12345

# Pipe the new body from stdin
echo "new body" | glab mr note update 1 12345

# Add a screenshot to the existing note body
glab mr note update 1 12345 --attach ./screenshot.png

Options

plaintext
      --attach stringArray   (EXPERIMENTAL) Upload a file and reference it at the end of the note. Use "-" to read the file from standard input. Repeat the flag to attach multiple files.
  -m, --message string       New note body. If omitted, opens an editor or reads from stdin.

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 note 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 the body of a note on a merge request. (EXPERIMENTAL)
15## Synopsis
17Replace the body of an existing note on a merge request.
19`<note-id>` is a numeric note ID, not a hex discussion ID.
20You can find note IDs with:
22- `glab mr note list -F json` (the `.id` field)
23- Note URLs: `.../merge_requests/1#note_12345`
25You can change only the note body. You cannot move the position of diff notes.
27`--attach` uploads a file and references it at the end of the note. Repeat the flag for more than one file, or pass `-` to read the file from standard input. Without `--message`, standard input that is not a terminal is read as the new body. It replaces the existing body, unless `--attach -` reads the file from standard input. With neither `--message` nor piped input, the references are added to the body the note already has, instead of replacing it. The command waits until standard input closes, so to keep the existing body from a script, redirect standard input from `/dev/null`.
29This feature is an experiment and is not ready for production use.
30It might be unstable or removed at any time.
31For more information, see
32<https://docs.gitlab.com/policy/development_stages_support/>.
34```plaintext
35glab mr note update [<id> | <branch>] <note-id> [flags]
36```
38## Examples
40```console
41# Update note 12345 on merge request 1 with a new message
42glab mr note update 1 12345 -m "Updated comment"
44# Update a note on the current branch's merge request, composing in an editor
45glab mr note update 12345
47# Pipe the new body from stdin
48echo "new body" | glab mr note update 1 12345
50# Add a screenshot to the existing note body
51glab mr note update 1 12345 --attach ./screenshot.png
53```
55## Options
57```plaintext
58 --attach stringArray (EXPERIMENTAL) Upload a file and reference it at the end of the note. Use "-" to read the file from standard input. Repeat the flag to attach multiple files.
59 -m, --message string New note body. If omitted, opens an editor or reads from stdin.
60```
62## Options inherited from parent commands
64```plaintext
65 -h, --help Show help for this command.
66 -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.
67```
Diagnostics8 git calls · 292 ms
CallStatusSizeTime0292 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=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 KiB2 ms
git.upload-pack ls-refs
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=ls-refs
git.upstream.dur_ms=2
git.response.bytes=59849
git.response.cache=UPDATING
git.response.duration_ms=2
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 · 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
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:02001.7 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=1744
git.response.cache=HIT
git.response.duration_ms=3
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
fetchtree:0200320 B · hit2 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=279
git.response.bytes=320
git.response.cache=HIT
git.response.duration_ms=2
git.fetch.filter=tree:0
git.fetch.wants=26e1df371683d775a58e6541e378e4f0c2f3d7d0
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=320
git.pkt.payload.max=293
git.sideband.band1.bytes=293
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0
git.pack.objects=1
git.pack.bytes=293
git.pack.trailer=835632d6a936ff937caaf1aeb117c22834ab3425
Open pack map
fetch2001.3 KiB279 ms
git.upload-pack fetch
http.response.status_code=200
git.response.bytes=1296
git.response.cache=MISS
git.response.duration_ms=279
git.fetch.wants=6cb0075d3a963108a303c3d799708353e5f056e1
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=1296
git.pkt.payload.max=1269
git.sideband.band1.bytes=1269
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
a5e197aaaa8bb86e
Request
0524c9e5…
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