如何使用 curl 命令在 API 中标记提交

Question

我正在尝试使用 curl 命令来标记提交。这可能吗？我浏览了来自 GitHub 的 create-a-tag-object 链接，但它不起作用。

Answer 1

创建标签有点复杂，但如果您只遵循 API 文档，应该没问题。注意API docs say:

请注意，创建标签对象不会创建在 Git 中创建标签的引用。如果要在 Git 中创建带注释的标签，则必须执行此调用以创建标签对象，然后创建 refs/tags/[tag] 引用。如果你想创建一个轻量级标签，你只需要创建引用——这个调用是不必要的。

因此，在继续创建标签之前，您应该知道要创建什么样的标签——annotated or lightweight。基本上，带注释的标签与轻量级标签相同，但它还包含标签的消息、标签作者的信息以及标签的创建日期和时间。轻量级标签只是指向历史中特定提交的命名指针。

好的，API 文档基本上是这样说的：如果你想创建一个带注释的标签 - 你必须进行 2 次 API 调用，如果你想创建一个轻量级标签 - 你只需要进行 1 次称呼。因此，我将给出一个使用 2 个 API 调用创建带注释标签的示例，如果您想创建一个轻量级标签 - 只需跳过第一个 API 调用并转到第二个。

要创建带注释的标签，您必须：

步骤 1

Create a tag object using the tags API。 API 文档在这里有点不清楚应该如何传递参数。缺少的是您需要发送到服务器的消息示例。因此，在本地磁盘上创建一个名为 tag_object_req.json 的文件，并将以下 JSON 文档放入其中：

{
  "tag": "v0.0.1",
  "object": "c5f8759ffd808d4a57ea36c63960f3e2cc6fcc2b",
  "message": "creating a tag",
  "tagger": {
    "name": "Ivan Zuzak",
    "email": "izuzak@gmail.com",
    "date": "2012-06-17T14:53:35-07:00"
  },
  "type": "commit"
}

显然，您必须替换文档中的信息以反映您的情况。 API文档here中描述了参数的含义。

保存文件后，您可以使用 curl 进行 API 调用来创建标签对象：

curl -v -X POST -d @tag_object_req.json --header "Content-Type:application/json" -u izuzak "https://api.github.com/repos/izuzak/test/git/tags"

所以，-v 部分将强制 curl 输出所有 HTTP 标头，-X POST 部分表示必须发出 HTTP POST 请求，-d @tag_object_req.json 指定将使用哪个文件作为内容（正文） POST 请求，--header "Content-Type:application/json" 指定请求的媒体类型（JSON 消息），-u izuzak 指定用于授权的用户名（并且 curl 会在您发出请求时询问您的密码）。

您得到的响应应该是201 Created HTTP 响应，JSON 消息的结构如下：

{
  "sha": "e6d9fb6b9a13cab11923345e2400d5cf8df97267",
  "url": "https://api.github.com/repos/izuzak/test/git/tags/e6d9fb6b9a13cab11923345e2400d5cf8df97267",
  "tagger": {
    "name": "Ivan Zuzak",
    "email": "izuzak@gmail.com",
    "date": "2012-06-17T21:53:35Z"
  },
  "object": {
    "sha": "c5f8759ffd808d4a57ea36c63960f3e2cc6fcc2b",
    "type": "commit",
    "url": "https://api.github.com/repos/izuzak/test/git/commits/c5f8759ffd808d4a57ea36c63960f3e2cc6fcc2b"
  },
  "tag": "v0.0.1",
  "message": "creating a tag"
}

在继续之前，请注意您刚刚创建的对象 (e6d9fb6b9a13cab11923345e2400d5cf8df97267) 的 sha 属性，因为您将在下一步中使用该值。

第二步

Create a tag reference using the references API。 API 文档在这里更清楚地说明了请求的外观。因此，您首先必须在磁盘上创建另一个文件，命名为tag_ref_req.json，并将此内容放入其中：

{
  "ref": "refs/tags/v0.0.1",
  "sha": "e6d9fb6b9a13cab11923345e2400d5cf8df97267"
}

但是，请注意，此 JSON 中 sha 的值取决于您创建的标签类型。如果您正在创建带注释的标记，则 sha 的值与您从上一步中获得的值相同 - 标记对象的 sha (e6d9fb6b9a13cab11923345e2400d5cf8df97267)。但是，如果您正在创建轻量级标记，则 sha 的值是您使用标记标记的提交对象的 sha，因为您尚未创建标记对象。就我而言，您可以在第 1 步中看到我要标记的提交对象是 c5f8759ffd808d4a57ea36c63960f3e2cc6fcc2b，如果您正在创建轻量级标记，这当然会有所不同。

好的，所以在您创建了这个文件并定义了标签的sha和名称之后，您可以使用curl以与上一步类似的方式发出API请求：

curl -v -X POST -d @tag_ref_req.json --header "Content-Type:application/json" -u izuzak "https://api.github.com/repos/izuzak/test/git/refs"

请注意，我们现在正在以第二个文件作为内容向https://api.github.com/repos/izuzak/test/git/refs 发出请求。

响应应该还是一个201 Created HTTP 响应，并且正文将是一个如下所示的 JSON 文档：

{
  "ref": "refs/tags/v0.0.1",
  "url": "https://api.github.com/repos/izuzak/test/git/refs/tags/v0.0.1",
  "object": {
    "sha": "e6d9fb6b9a13cab11923345e2400d5cf8df97267",
    "type": "tag",
    "url": "https://api.github.com/repos/izuzak/test/git/tags/e6d9fb6b9a13cab11923345e2400d5cf8df97267"
  }
}

现在您可以导航到 GitHub 上的项目并转到“切换分支/标签”并在那里查看您的标签。

希望这会有所帮助！

Answer 2

您也可以尝试新的 Releases API

http://developer.github.com/v3/repos/releases/#create-a-release

curl \
    --user <username> \
    --header "Accept: application/vnd.github.manifold-preview" \
    --data "tag_name=mytagname" \
    "https://api.github.com/repos/<username>/<repository>/releases"

Answer 3

这是 curl 将创建 版本。 （但正如ChucK 提到的它可能只创建轻量级标签，我还没有亲自验证过）

curl \
    --user <Your Github username> \
    --header "Accept: application/vnd.github.manifold-preview" \
    --data '{"tag_name": "v1.0.0", "target_commitish": "master", "name": "v1.0.0", "body": "Description of the release", "draft": false, "prerelease": false }' \
"https://api.github.com/repos/<OrganizationName>/<RepoName>/releases" -X POST

在这里添加这个，以防有人来找这个，比如我。