介绍
在开发应用程序的新功能或修复错误时,使用 GitHub UI 打开拉取请求很快就会变得乏味。您必须导航到相关的 GitHub 存储库,选择要提交拉取请求的分支,然后执行与创建拉取请求相关的后续步骤。GitHub 开发人员 API 旨在将所有这些抽象为一个简单的 HTTP 调用。从长远来看,此 API 可以为您节省大量时间。
本指南将演示如何使用 GitHub API 通过创建您自己的命令行或 UI 来为您创建拉取请求,以便省去此过程中所需的大量手动步骤。
让我们开始吧!
API 概述和设置
GitHub API 分为两大部分:REST 和 GraphQL。本指南将使用 REST API,但如果您习惯使用 GraphQL,GraphQL API 也是一个很好的选择。
您需要做的第一件事是安装@octokit/core NPM 依赖项。这是 GitHub 的核心开发人员工具包,也是本指南将用于与 GitHub 的 REST API 交互的 NPM 包。要安装此依赖项,请导航到您的顶级项目目录并运行:
npm install --save-dev @octokit/core
安装此依赖项后,下一步将是生成个人访问令牌,以便您的程序可以成功通过 GitHub 的 REST API 进行身份验证。为此,请导航到GitHub 帐户的令牌设置部分并按照屏幕上的步骤操作。
下载依赖项并准备好个人访问令牌后,就可以开始与 GitHub API 交互了。
以编程方式创建拉取请求
GitHub API 提供了许多用于创建拉取请求的选项。您可以在此处查看这些选项和可用的配置。
现在您已经进入了 JavaScript 代码,是时候看看这个 API 可以做什么了!
注意:不要忘记保密您的授权令牌!不要将您的令牌签入源代码管理!
import { Octokit } from "@octokit/core";
const octokit = new Octokit({ auth: 'your-token!' }),
owner = 'test-user',
repo = 'test-repo',
title = 'My Test Pull Request',
body = 'This pull request is a test!',
head = 'my-feature-branch',
base = 'develop-branch';
const response = await octokit.request(
`POST /repos/{owner}/{repo}/pulls`, { owner, repo, title, body, head, base }
);
哇,这真的很简单!如您所见,首先您需要从 GitHub 的开发者 API 项目导入Octokit类。使用您的个人访问令牌实例化Octokit类的实例后,您就可以使用请求方法打开新的拉取请求。上面的示例使用了许多可用于此特定 API 请求的选项。以下列表是对最常用选项的细分:
- 所有者:必需选项,指定存储库所有者的用户名
- repo:必需选项,这是所讨论的 repo 名称
- head:必需选项,为 API 提供包含更改的分支的名称
- base:必需选项,为 API 提供你尝试修改的分支的名称
- title:此选项不是必需的。这是您的拉取请求的标题。
- body:此选项不是必需的。这是拉取请求描述。
运行上述代码后,您现在可以在浏览器中导航到 GitHub 存储库并查看您提交的拉取请求!
结论
GitHub 开发人员 API 提供了丰富的功能,可与您的 GitHub 代码库进行编程交互。除了简单地创建拉取请求之外,您还可以使用更多功能!我鼓励您查看GitHub REST API 文档,了解可用的大量选项。
免责声明:本内容来源于第三方作者授权、网友推荐或互联网整理,旨在为广大用户提供学习与参考之用。所有文本和图片版权归原创网站或作者本人所有,其观点并不代表本站立场。如有任何版权侵犯或转载不当之情况,请与我们取得联系,我们将尽快进行相关处理与修改。感谢您的理解与支持!