安科网

使用 Github API 更新仓库

ingwengang

ingwengang

2019-06-30

关注 关注

原文链接：https://ssshooter.com/2019-01...

0. 总览

本文为大家提供一种使用 GitHub API 更新 GitHub 仓库的方法。通常我们会使用 Git 客户端 Commit 然后 Push 到 GitHub，但 GitHub 为我们提供了相关 API，在某些情况下可以直接通过 API 更新仓库。

在此之前有一些前置知识点，你需要了解 git 的储存原理。碰巧最近掘金有一篇很火的文章有提到相关知识。

使用 Github API 更新仓库

使用 GitHub API 更新仓库只需六步。虽然对于第一次接触的新手来说可能会有点复杂，但是理清关系之后思路便会很清晰了。

  1. 获取 Ref：Ref 指 Git 的引用。如果要发起 Commit，必须知道你的 Commit 要提交到什么地方去（Commit 是一个接一个的链状关系，所以需要知道上一个 Commit 的信息），这一步做的就是这件事。
  2. 获取 Commit：用于获取当前 Commit 的 tree 的 sha。
  3. 生成 Blob：相当于正常本地提交的 add 操作，可以参考这里的解释。
  4. 生成 Tree：构建一个新的 tree，把上一步生成的 Blob 放到合适的位置。这里需要用到的参数 base_tree 就是来自第二步的 Commit 信息。
  5. 生成 Commit：提交你的 tree，这步跟正常 commit 很接近，不过要你手动找到此次提交的上一次提交，借哈希值把新的 Commit 接起来。
  6. 更新 Ref：使 master 的指针指到你最新提交的版本。

注意：访问 POST 方法的接口必须带 token，虽然 GET 可以不带，但是会限制访问频率，所以建议都带上。相关文档：https://developer.github.com/v3/#authentication

1. 获取 Ref 

1.1 文档地址

https://developer.github.com/v3/git/refs/#get-a-reference

1.2 请求地址

GET https://api.github.com/repos/ssshooter/test/git/refs/heads/master

1.3 返回数据

{
  "ref": "refs/heads/master",
  "node_id": "MDM6UmVmMTY0Nzk4NDczOm1hc3Rlcg==",
  "url": "https://api.github.com/repos/ssshooter/test/git/refs/heads/master",
  "object": {
    "sha": "cda66de943082033f4b761639df77728d7bca4f0",
    "type": "commit",
    "url": "https://api.github.com/repos/ssshooter/test/git/commits/cda66de943082033f4b761639df77728d7bca4f0"
  }
}

2. 获取 Commit

2.1 文档地址

https://developer.github.com/v3/git/commits/#get-a-commit

2.2 请求地址

GET https://api.github.com/repos/ssshooter/test/git/commits/cda66de943082033f4b761639df77728d7bca4f0

2.3 返回数据

{
  "sha": "cda66de943082033f4b761639df77728d7bca4f0",
  "node_id": "MDY6Q29tbWl0MTY0Nzk4NDczOmNkYTY2ZGU5NDMwODIwMzNmNGI3NjE2MzlkZjc3NzI4ZDdiY2E0ZjA=",
  "url": "https://api.github.com/repos/ssshooter/test/git/commits/cda66de943082033f4b761639df77728d7bca4f0",
  "html_url": "https://github.com/ssshooter/test/commit/cda66de943082033f4b761639df77728d7bca4f0",
  "author": {
    "name": "DeJavuJo",
    "email": "[email protected]",
    "date": "2019-01-09T06:02:07Z"
  },
  "committer": {
    "name": "GitHub",
    "email": "[email protected]",
    "date": "2019-01-09T06:02:07Z"
  },
  "tree": {
    "sha": "d7a57d28ace0db12773c7d70675f94a48da6421f",
    "url": "https://api.github.com/repos/ssshooter/test/git/trees/d7a57d28ace0db12773c7d70675f94a48da6421f"
  },
  "message": "Create readme.md",
  "parents": [
  ],
  "verification": {
    "verified": true,
    "reason": "valid",
    "signature": "-----BEGIN PGP SIGNATURE-----\n\nwsBcBAABCAAQBQJcNY5fCRBK7hj4Ov3rIwAAdHIIABh8I89hATqg1mSYtpx1aY\nJt/woDobMO7FGE5qXO0NNrCMqwF6mdPJOMMMZvVWF1ULTm8ZJ52GAh5xAnPMZEnQ\n8tTjj/Qc0eZCm5B1xO66rgx+7eKkeGUPJj5bX7Lf0i9Se70Ff0jaCdH94RgiSL2d\nclDLhNyM4u6AH//k7S3Ud1O6ezXd4+99381Xa331PDLhJttUAbRFRCThszbcxRUT\nPvyhPNvXB5ug4J+tAMaZJvZEaED0c1k2Yx1+TYkLvPjOlqXvqaDVpMZieluD5l+f\nu13NAoCnLfBe0Skak/8MxRDbMcJYNW78ll60HAa6jJtElD8Vkek8WoVAZ8p3iIE=\n=xI87\n-----END PGP SIGNATURE-----\n",
    "payload": "tree d7a57d28ace0db12773c7d70675f94a48da6421f\nauthor DeJavuJo  1547013727 +0800\ncommitter GitHub  1547013727 +0800\n\nCreate readme.md"
  }
}

3. 生成 Blob

3.1 文档地址

https://developer.github.com/v3/git/blobs/#create-a-blob

3.2 请求地址

POST https://api.github.com/repos/ssshooter/test/git/blobs

3.3 请求参数

{
  "content": "Content of the blob",
  "encoding": "utf-8"
}

3.4 返回数据

{
    "sha": "929246f65aab4d636cb229c790f966afc332c124",
    "url": "https://api.github.com/repos/ssshooter/test/git/blobs/929246f65aab4d636cb229c790f966afc332c124"
}

4. 生成 tree

4.1 文档地址

https://developer.github.com/v3/git/trees/#create-a-tree

4.2 请求地址

POST https://api.github.com/repos/ssshooter/test/git/trees

4.3 请求参数

注意：tree.path 可以写深层目录，如 deep/deep/newFile.md（前面不用写斜杠）

{
  "base_tree": "d7a57d28ace0db12773c7d70675f94a48da6421f", // commit tree 的 sha
  "tree": [
    {
      "path": "apiCommitFile.md", // 文件路径
      "mode": "100644", // 类型，详情看文档
      "type": "blob",
      "sha": "929246f65aab4d636cb229c790f966afc332c124" // 刚才生成的 blob 的 sha
    }
  ]
}

4.4 返回数据

{
    "sha": "2b3a65095ceb7cf4425f52d59ca5974d826cff80",
    "url": "https://api.github.com/repos/ssshooter/test/git/trees/2b3a65095ceb7cf4425f52d59ca5974d826cff80",
    "tree": [
        {
            "path": "readme.md",
            "mode": "100644",
            "type": "blob",
            "sha": "b1b716105590454bfc4c0247f193a04088f39c7f",
            "size": 5,
            "url": "https://api.github.com/repos/ssshooter/test/git/blobs/b1b716105590454bfc4c0247f193a04088f39c7f"
        },
        {
            "path": "tree",
            "mode": "040000",
            "type": "tree",
            "sha": "91d8d59147e395effaeacd01c9d8553b37cf77c5",
            "url": "https://api.github.com/repos/ssshooter/test/git/trees/91d8d59147e395effaeacd01c9d8553b37cf77c5"
        }
    ],
    "truncated": false
}

5. 生成 Commit

5.1 文档地址

https://developer.github.com/v3/git/commits/#create-a-commit

5.2 请求地址

POST https://api.github.com/repos/ssshooter/test/git/commits

5.3 请求参数

{
  "message": "a Commit with GitHub api",
  "parents": [
    "cda66de943082033f4b761639df77728d7bca4f0" // 上次 commit 的sha
  ],
  "tree": "2b3a65095ceb7cf4425f52d59ca5974d826cff80"
}

5.4 返回数据

{
    "sha": "45c58a9358b67fc81e4034cb36c5196d791686ef",
    "node_id": "MDY6Q29tbWl0MTY0Nzk4NDczOjQ1YzU4YTkzNThiNjdmYzgxZTQwMzRjYjM2YzUxOTZkNzkxNjg2ZWY=",
    "url": "https://api.github.com/repos/ssshooter/test/git/commits/45c58a9358b67fc81e4034cb36c5196d791686ef",
    "html_url": "https://github.com/ssshooter/test/commit/45c58a9358b67fc81e4034cb36c5196d791686ef",
    "author": {
        "name": "ssshooter",
        "email": "[email protected]",
        "date": "2019-01-09T10:24:10Z"
    },
    "committer": {
        "name": "ssshooter",
        "email": "[email protected]",
        "date": "2019-01-09T10:24:10Z"
    },
    "tree": {
        "sha": "2b3a65095ceb7cf4425f52d59ca5974d826cff80",
        "url": "https://api.github.com/repos/ssshooter/test/git/trees/2b3a65095ceb7cf4425f52d59ca5974d826cff80"
    },
    "message": "a Commit with GitHub api",
    "parents": [
        {
            "sha": "cda66de943082033f4b761639df77728d7bca4f0",
            "url": "https://api.github.com/repos/ssshooter/test/git/commits/cda66de943082033f4b761639df77728d7bca4f0",
            "html_url": "https://github.com/ssshooter/test/commit/cda66de943082033f4b761639df77728d7bca4f0"
        }
    ],
    "verification": {
        "verified": false,
        "reason": "unsigned",
        "signature": null,
        "payload": null
    }
}

6. 更新 Ref

6.1 文档地址

https://developer.github.com/v3/git/refs/#update-a-reference

6.2 请求地址

https://api.github.com/repos/ssshooter/test/git/refs/heads/master

6.3 请求参数

{
    "sha":"45c58a9358b67fc81e4034cb36c5196d791686ef",
    "force":true
}

6.4 返回数据

{
    "ref": "refs/heads/master",
    "node_id": "MDM6UmVmMTY0Nzk4NDczOm1hc3Rlcg==",
    "url": "https://api.github.com/repos/ssshooter/test/git/refs/heads/master",
    "object": {
        "sha": "45c58a9358b67fc81e4034cb36c5196d791686ef",
        "type": "commit",
        "url": "https://api.github.com/repos/ssshooter/test/git/commits/45c58a9358b67fc81e4034cb36c5196d791686ef"
    }
}

7. node.js 实践代码

var updateGitHubRes = function(blob, path) {
  var commitSha
  var commitTreeSha
  return getRef()
    .then(({ data }) => {
      commitSha = data.object.sha
      return getCommit(commitSha)
    })
    .then(({ data }) => {
      commitTreeSha = data.tree.sha
      return createBlob(blob)
    })
    .then(({ data }) => {
      var blobSha = data.sha
      return createTree(commitTreeSha, path, blobSha)
    })
    .then(({ data }) => {
      var treeSha = data.sha
      return createCommit(commitSha, treeSha)
    })
    .then(({ data }) => {
      var newCommitSha = data.sha
      return updataRef(newCommitSha)
    })
    .catch(err => {
      console.log(err)
    })
}

var getRef = function() {
  return axios.get(`/${owner}/${repo}/git/refs/heads/master`)
}

var getCommit = function(commitSha) {
  return axios.get(`/${owner}/${repo}/git/commits/${commitSha}`)
}

var createBlob = function(content) {
  return axios.post(`/${owner}/${repo}/git/blobs`, {
    content,
    encoding: 'utf-8'
  })
}

var createTree = function(base_tree, path, sha) {
  return axios.post(`/${owner}/${repo}/git/trees`, {
    base_tree, // commit tree 的 sha
    tree: [
      {
        path, // 文件路径
        mode: '100644', // 类型，详情看文档
        type: 'blob',
        sha // 刚才生成的 blob 的 sha
      }
    ]
  })
}

var createCommit = function(parentCommitSha, tree, message = 'update post') {
  return axios.post(`/${owner}/${repo}/git/commits`, {
    message,
    parents: [parentCommitSha],// 上次 commit 的sha
    tree
  })
}

var updataRef = function(newCommitSha) {
  return axios.post(`/${owner}/${repo}/git/refs/heads/master`, {
    sha: newCommitSha,
    force: true
  })
}

参考文献

https://int128.hatenablog.com/entry/2017/09/05/161641
https://juejin.im/post/5c33f49de51d45523070f7bb
https://git-scm.com/book/zh/v2/Git-内部原理-Git-引用

api

ingwengang

ingwengang

0 关注 0 粉丝 0 动态

关注 关注

相关推荐

python 爬虫如何实现百度翻译

本文将会通过爬虫的方式实现简单的百度翻译。本文中的代码只供学习，不允许作为于商务作用。若有侵犯，立即删文！在网站文件中找到隐藏的免费api。传入api所需要的参数并对其发出请求。在返回的json结果里找到相应的翻译结果。进入百度翻译，随便输入一段需要翻译的

染血白衣 2020-11-16

net core webapi多版本控制与swagger（nswag）配置教程

首先希望webapi支持多版本，swagger针对不同的版本可进行交互。这种方式很直观，但如果原有项目没有使用多版本控制不建议用，可采用header的方式更为合理一些，增加多个 [ApiVersion]即可。但是两个相同的版本中Controller不能有相

SAMXIE 2020-11-04

4个下一个JavaScript项目的有趣API

术语API是首字母缩写词，代表“应用程序编程接口”。同样，一个API也列出了一堆开发者可以使用的操作，以及对这些操作的描述。API使开发人员可以利用平台的实现来执行一些有用的任务，从而节省时间。这也有助于减少开发人员需要为其程序编写的代码行数，因为API使

一个智障 2020-11-15

前端api请求缓存方案

在开发 web 应用程序时，性能都是必不可少的话题。对于webpack打包的单页面应用程序而言，我们可以采用很多方式来对性能进行优化，比方说 tree-shaking、模块懒加载、利用 extrens 网络cdn 加速这些常规的优化。而事实上，缓存一定是提

学习web前端 2020-11-09

Spring API 的 CORS 测试

在开发 API 和前端的时候，最麻烦的就是一个 CORS 测试。你不知道你的 API 是否允许 CORS，也不知道是不是因为前端的原因。但是 CORS 这个跨域访问确实让人非常头疼。## 写个页面为了解决这个问题，我们用 HTML 写了个页面，这个页面可以

yiranpiaoluo 2020-11-04

看看人家那后端API接口写得，那叫一个优雅！

在移动互联网，分布式、微服务盛行的今天，现在项目绝大部分都采用的微服务框架，前后端分离方式，。前端和后端进行交互，前端按照约定请求URL路径，并传入相关参数，后端服务器接收请求，进行业务处理，返回数据给前端。这样虽然能够照常满足业务，但状态码太凌乱了。这样

lxhuang 2020-11-03

WebAssembly及其 API 的完整介绍

自从引入计算机以来，本地应用程序的性能有了巨大的提高。相比之下，web 应用程序相当慢，因为 JS 一开始并不是为了速度而构建的。但是由于浏览器之间的激烈竞争以及JS 引擎如V8的快速开发，使得 JS 能够在机器上快速运行。但是它仍然不能超过本机应用程

88274956 2020-11-03

Postman API 获得文件如何保存

我们会使用 Postman 测试 API 的测试功能。如果我们直接使用 Postman 发送数据到 API ，API 会返回二进制的数据，然后 Postman 会尝试打开，很不幸的是，你将会看到下面的内容。有 2 个办法可以解决这个问题。一个是在发送的时候

82387067 2020-11-03

使用Node.js原生API写一个Web服务器

Node.js是JavaScript基础上发展起来的语言，所以前端开发者应该天生就会一点。一般我们会用它来做CLI工具或者Web服务器，做Web服务器也有很多成熟的框架，比如Express和Koa。所以本文其实是这两个源码解析的前置知识，可以帮我们更好的理

huangliuyu00 2020-10-29

Facebook：如何在Golang中搭建GraphQL？

本文转载自公众号“读芯术”。多年来，人们一直在使用REST API来满足开发需求，但得完成大量不必要的调用后，开发者才能灵活使用。本文将重点介绍GraphQL的主要功能，以及就API而言它存在的优缺点。文末将展示一个使用Golang的简单程序。Graph

sichenglain 2020-10-27

Java中的微信支付之一：API V3版本签名详解

最近在折腾微信支付，证书还是比较烦人的，所以有必要分享一些经验，减少你在开发微信支付时的踩坑。目前微信支付的 API 已经发展到V3版本，采用了流行的 Restful 风格。今天来分享微信支付的难点——签名，虽然有很多好用的 SDK 但是如果你想深入了解

Dayer 2020-10-27

Postman 测试 API 如何上传文件

很多时候我们都会用 Postman 来测试 API。如何在 Postman 中进行设置来上传文件？Postman 已经帮我们想到了。在进入 Postman 以后，找到你需要进行测试的 API，然后选择 body。其实主要开始很多人不知道怎么设置的原因是，你

小马的学习笔记 2020-10-23

「机器学习架构」一个真实世界机器学习系统的架构

在「机器学习」机器学习开发平台概述，我概述了ML开发平台，它们的工作是帮助创建和打包ML模型。模型构建只是ML系统所需的众多功能中的一项。在这篇文章的最后，我提到了其他类型的ML平台以及构建现实世界ML系统时的限制。在我们能够讨论这些之前，我们需要回顾这些

liuweiITlove 2020-10-14

服务网格和API网关在微服务架构中的作用

如果您从事微服务，那么您可能已经多次听说过这两个术语。人们常常在两者之间感到困惑。在本文中，我将详细讨论服务网格和API网关，并讨论何时使用。在深入研究服务网格和API网关之前，让我们重新访问网络层。API网关充当进入集群，数据中心或一组分布式服务的单个入

kjyiyi 2020-10-10

码农编写代码的方式即将改变，快加入等待列表吧

OpenAI API即将彻底改变编码。好吧，这很容易; 它应该是pwd。如果要导航到/ tmp文件夹怎么办?现在，您最想知道的是，用于计算当前文件夹中python文件数量的命令是什么?类型的f -name'* .py'| wc -l。这并不难，也可以通过其

fanjunjaden 2020-10-09

GraphQL初体验，Node.js构建GraphQL API指南

在过去的几年中，GraphQL[1]已经成为一种非常流行的API规范，该规范专注于使客户端的数据获取更加容易。但是，在GraphQL中，客户端可以精确地确定其从服务器获取的数据。与任何技术决策一样，了解GraphQL为你的项目提供了哪些优势是很重要的，而不

zhyue 2020-09-28

Webhooks与API的区别在哪里？

Webhooks起初看起来像是API，但它们略有不同。它们之间的主要区别在于，webhooks不需要发出请求即可获得响应，而API则需要发送请求才能获得响应。使用Webhooks可以接收，而API需要您检索。正确设置了Webhook之后，无论何时更新Git

huangliuyu00 2020-09-24

微软获GPT-3独家授权，可访问底层代码，API用户继续使用

微软今天宣布，获得OpenAI GPT-3的独家授权。毕竟也是投资10亿美元的金主爸爸，这个结果并不意外。虽然目前尚不清楚具体授权许可内容，但声明中说了，这项协议将允许微软其技术为自身客户开放和提供更优的AI解决方案。微软CTO、兼执行副总裁Kevin S

88397813 2020-09-23

Kafka都没整明白，还敢去面试？

放眼当下数据为王的时代，深入了解 Apache Kafka 及其常见的部署应用，快速实现数据架构已是大势所趋，刻不容缓。以下分别 Kafka 架构，四大核心 API，典型应用场景，Kafka 代理与消息主题，集群的创建，流 APIs及其处理模式等不同方面展

jyj0 2020-09-21

使用类似搭积木的低代码开发方式进行SAP API开发

Jerry之前的文章SAP API开发方法大全介绍的第七种SAP API开发方式，SAP Data Intelligence Graph，实际上是Low Code Development的一种体现。打开Modeler的Operators标签页，看到位于不同

zhyue 2020-09-19
ingwengang

ingwengang

W3CSchool教程
HTML 教程
CSS 教程
Bootstrap 教程
Javascript 教程
jQuery 教程
后端教程
C 教程
Java 教程
PHP 教程
Python 教程
Go 教程
移动开发
Android 教程
Swift 教程
Kotlin 教程
jQuery Mobile 教程
ionic 教程
关于我们
新闻动态
联系方式
招聘英才
安科实验室
帮助与反馈

安科网(Ancii)，中国第一极客网

Copyright © 2013 - 2019 Ancii.com

京ICP备18063983号 京公网安备11010802014868号