GitLab API 将内联评论发布到合并请求

Question

使用 GitLab API 可以在“特定文件的特定行”上对提交发表评论（参见此处）。

在合并请求上，为了添加注释，需要使用注释资源（请参见此处），但注释object 似乎不包含任何参数来评论特定行。

但是，从 GitLab UI 我可以在“更改”选项卡中向合并请求添加内联注释，但是当我调用 API 并查看相应的注释ZA8CFDE6331BD59EB2AC96F8911C4B6666Z常规注释object 没有任何 line 或 line_type 参数...

任何人都知道如何使用 GitLab API 在合并请求中添加内联注释？

Answer 1

notes API仅用于向合并请求添加注释。

为了向源代码添加内联注释，您必须使用此其他API端点：

https://docs.gitlab.com/ce/api/commits.html#post-comment-to-commit

但是这个API在提交列表中设置了注释。 您不会在“合并请求”页面中的任何位置看到评论。

Answer 2

为了添加合并请求的内联注释，有Discussions API： https ： //docs.gitlab.com/ce/api/discussions.html

每个讨论都可以在代码中包含一个位置，如下所示：

    "position": {
      "base_sha": "b5d6e7b1613fca24d250fa8e5bc7bcc3dd6002ef",
      "start_sha": "7c9c2ead8a320fb7ba0b4e234bd9529a2614e306",
      "head_sha": "4803c71e6b1833ca72b8b26ef2ecd5adc8a38031",
      "old_path": "package.json",
      "new_path": "package.json",
      "position_type": "text",
      "old_line": 27,
      "new_line": 27
    },

Answer 3

代码

functions.yml

.commit_comment:
  script:
    - export GITLAB_TOKEN="PROJECT_ACCESS_TOKEN"
    - |
      commit_comment() {
        curl --location --request POST "https://gitlab.com/api/v4/projects/$CI_MERGE_REQUEST_PROJECT_ID/merge_requests/$CI_MERGE_REQUEST_IID/notes" --header "PRIVATE-TOKEN: $GITLAB_TOKEN" --header "Content-Type: application/json" --data-raw "{ \"body\": \"$1\" }"
      }

如何使用？

# ...
script:
    - !reference [.commit_comment, script]
    - commit_comment "YOUR_MESSAGE"
# ...

ℹ️ Markdown 被允许用于消息

生成令牌

• Go 到您的项目 > 设置 > 访问令牌
• 输入令牌名称
• 选择Reporter作为角色
• Select api scope。 您可以添加更多范围，但这就是我们所需要的
• 生成令牌

---

Ps 在这里，我创建了一个 function 用于多个作业，但您也可以通过将$1替换为您的消息直接在任何地方直接使用curl命令。

参考