17

据我了解，消息与提交相关联。但是，当您查看 GitHub 上的存储库时，它会很有帮助地按每个文件列出消息，以及上次更改的时间。

我想在我拥有的回购的网络视图中复制它。查看 GitHub api，在我看来，获取该信息的唯一方法是下载所有提交（可以分页），并从最近的提交消息开始工作，将提交消息分配给本地缓存中的文件，进一步再往前追溯，直到您收到每个文件的消息，可能是第一次提交，如果任何文件自初始提交以来没有更改

问题是，这是正确的做法吗？这不会杀死甚至 5000/hr 的配额吗？

4

3 回答 3

37

好的，在弄清楚您需要的是每个文件的最新提交消息之后，您可以执行以下操作。

首先，获取存储库中的文件列表。为此，您需要：

1)获取要为其列出文件的分支的引用对象：

GET https://api.github.com/repos/:owner/:repo/git/refs/heads/:branch

您可能需要 master 分支，因此这是您将提出的请求的示例：

https://api.github.com/repos/izuzak/pmrpc/git/refs/heads/master

您将得到的响应将如下所示：

{
  "ref": "refs/heads/master",
  "url": "https://api.github.com/repos/izuzak/pmrpc/git/refs/heads/master",
  "object": {
    "sha": "fd6973f430a3367ad718ff049f1b075843913d6f",
    "type": "commit",
    "url": "https://api.github.com/repos/izuzak/pmrpc/git/commits/fd6973f430a3367ad718ff049f1b075843913d6f"
  }
}

2)使用您在上一步中收到的响应的属性获取引用指向的提交对象：object.url

GET https://api.github.com/repos/izuzak/pmrpc/git/commits/fd6973f430a3367ad718ff049f1b075843913d6f

您将得到的响应将如下所示：

{
  "sha": "fd6973f430a3367ad718ff049f1b075843913d6f",
  "url": "https://api.github.com/repos/izuzak/pmrpc/git/commits/fd6973f430a3367ad718ff049f1b075843913d6f",
  "html_url": "https://github.com/izuzak/pmrpc/commits/fd6973f430a3367ad718ff049f1b075843913d6f",
  "author": {
    "name": "Ivan Zuzak",
    "email": "izuzak@gmail.com",
    "date": "2013-04-09T08:55:45Z"
  },
  "committer": {
    "name": "Ivan Zuzak",
    "email": "izuzak@gmail.com",
    "date": "2013-04-09T08:55:45Z"
  },
  "tree": {
    "sha": "f5f5de80f67dd794ffbd4abb855fb7d1a573660e",
    "url": "https://api.github.com/repos/izuzak/pmrpc/git/trees/f5f5de80f67dd794ffbd4abb855fb7d1a573660e"
  },
  "message": "fix typos",
  "parents": [
    {
      "sha": "d3617ae56dda793131e743b2ff394984bbab6ca3",
      "url": "https://api.github.com/repos/izuzak/pmrpc/git/commits/d3617ae56dda793131e743b2ff394984bbab6ca3",
      "html_url": "https://github.com/izuzak/pmrpc/commits/d3617ae56dda793131e743b2ff394984bbab6ca3"
    }
  ]
}

3)获取上一步获取的提交对象的树对象。您将按照tree.url上一步响应中提供的链接执行此操作：

GET https://api.github.com/repos/izuzak/pmrpc/git/trees/f5f5de80f67dd794ffbd4abb855fb7d1a573660e

响应将如下所示：

{
  "sha": "f5f5de80f67dd794ffbd4abb855fb7d1a573660e",
  "url": "https://api.github.com/repos/izuzak/pmrpc/git/trees/f5f5de80f67dd794ffbd4abb855fb7d1a573660e",
  "tree": [
    {
      "mode": "100644",
      "type": "blob",
      "sha": "726f21a4adec8c24c2fab6cf5b455d094a8b21bf",
      "path": "LICENSE.markdown",
      "size": 568,
      "url": "https://api.github.com/repos/izuzak/pmrpc/git/blobs/726f21a4adec8c24c2fab6cf5b455d094a8b21bf"
    },
    {
      "mode": "100644",
      "type": "blob",
      "sha": "eb94760b81441b34a73d1b085d9f153ae48b0e63",
      "path": "README.markdown",
      "size": 5772,
      "url": "https://api.github.com/repos/izuzak/pmrpc/git/blobs/eb94760b81441b34a73d1b085d9f153ae48b0e63"
    },
    {
      "mode": "040000",
      "type": "tree",
      "sha": "2e72b217b8644ce6874cda03387a7ab2d8eee55e",
      "path": "examples",
      "url": "https://api.github.com/repos/izuzak/pmrpc/git/trees/2e72b217b8644ce6874cda03387a7ab2d8eee55e"
    },
    {
      "mode": "100644",
      "type": "blob",
      "sha": "64b0dbe4981759c0f9640c8e882c97c7324fc798",
      "path": "pmrpc.js",
      "size": 24546,
      "url": "https://api.github.com/repos/izuzak/pmrpc/git/blobs/64b0dbe4981759c0f9640c8e882c97c7324fc798"
    }
  ]
}

这些是存储库中的所有文件和文件夹。但是请注意，对于文件夹，您需要递归地获取文件夹树对象以获取文件夹中的文件列表。在上面的响应中，这examples是一个文件夹，您可以通过 type 属性的树值看到它。因此，您将在文件夹提供的 url 上发送另一个 GET 请求：

  GET https://api.github.com/repos/izuzak/pmrpc/git/trees/2e72b217b8644ce6874cda03387a7ab2d8eee55e

另一种方法是通过一个请求获取所有文件（在所有文件夹中）的列表，使用recursive=1参数，如此处所述。我建议您使用这种方法，因为它只需要一个 HTTP 请求。

接下来，既然您在 repo 中有文件和文件夹的列表，您将获得更改每个文件/文件夹的最后一次提交。为此，请提出此请求

GET https://api.github.com/repos/:user/:repo/commits?path=FILE_OR_FOLDER_PATH

因此，例如，这是一个获取上述examples文件夹提交的请求：

GET https://api.github.com/repos/izuzak/pmrpc/commits?path=examples

您将得到的响应是提交对象的列表，您应该只查看该列表中的第一个对象（因为您对文件的最后一次提交感兴趣）并检索commit.message属性以获取您需要的消息：

[
  {
    "sha": "3437f015257683a86e3b973b3279754df9ac2b24",
    "commit": {
      "author": { ... },
      "committer": { ... },
      "message": "change mode",
      "tree": { ... },
      "url": "https://api.github.com/repos/izuzak/pmrpc/git/commits/3437f015257683a86e3b973b3279754df9ac2b24",
      "comment_count": 0
    },
    ...
  },
  {
    ...
  }
]

在这种情况下，更改文件夹的最新提交的消息examples是“更改模式”。

因此，基本上，您需要发出 3 个 HTTP 请求来获取文件列表，然后为每个文件和文件夹发出 1 个 HTTP 请求。坏消息是，如果您有大量文件——您将发出大量 HTTP 请求。好消息是您可以缓存响应，这样如果没有任何更改，您就不需要发出请求（有关更多信息，请参见此处）。此外，您不会一次获取所有提交消息，您将在用户浏览文件夹时获取它们（就像在 GitHub 上单击文件夹一样）。因此，您应该能够轻松地保持在 5000 个请求的限制范围内。

希望这可以帮助！如果您找到更简单的方法，请告诉我:)。我不知道是否有一种方法可以通过 1-2 个请求来实现这一点，这可能是您所期望的。

于 2013-04-10T18:02:37.013 回答
3

我在存储库上列出提交，而不是抓住第一个并阅读它的 SHA，它工作得很好：

https://developer.github.com/v3/repos/commits/#list-commits-on-a-repository

在 Go 中，它看起来像这样：

func GetLatestCommit(owner, repo string, sgc *github.Client) (string, error) {
    commits, res, err := sgc.Repositories.ListCommits(owner, repo, &github.CommitsListOptions{})

    if err != nil {
        log.Printf("err: %s res: %s", err, res)
        return "", err
    }

    log.Printf("last commit: %s", *commits[0].SHA)

    return *commits[0].SHA, nil
}
于 2015-09-05T17:42:11.843 回答
0

在寻找建立永久链接时，我发现检索提交 sha 的最简单方法之一是实际解析 html 页面。

好处：

  • 存储库中的所有文件/文件夹页面都有它，甚至是根
  • 单个 HTTP 调用
  • 无需身份验证登录
  • 将使用正确的分支（有些不使用 master 作为默认）
  • 也适用于树枝

Permalink每个文件页面上都有一个链接。如果您正在寻找识别该链接的方法，则可以使用类.js-permalink-shortcut和data-hotkey="y"属性，如获取文件的永久链接 - Github中所述。

<a href="/luckydonald/JavaPipBoyServer/blob/a6f4038336ff41463ad527b4ff4fda45642ebc6d/PROTOCOL.md" class="d-none js-permalink-shortcut" data-hotkey="y">Permalink</a>

所以在这个例子中 sha 是a6f4038336ff41463ad527b4ff4fda45642ebc6d.

请注意，它将始终呈现，即使您已经在该提交中。

如果有人喜欢从中建立永久链接，则#L437-L441需要手动保留（附加）url 哈希（例如，行引用，如 ）。

于 2017-07-20T22:31:27.460 回答