在前端开发中，我们经常需要使用到 GitHub 的 REST API，从而实现许多与代码版本控制相关的操作。然而，REST API 的使用方式相对来说还是比较繁琐的，需要自己编写一些复杂的代码才能够完成操作。为了让开发者更加便利地操作 GitHub，有不少的开发者将其封装成了 npm 包。其中，最为流行的就是 github-flow-js 这个包。本文将详细介绍如何使用该包以及其深层次的原理。
GitHub Flow 简介
在介绍 github-flow-js 的使用方法之前，我们需要先了解一下 GitHub Flow 这个概念。GitHub Flow 是一种围绕 GitHub 版本控制工作流程的推荐使用方式，它是一种基于分支的工作流程，主要的流程如下：
- 创建分支：每个任务或新功能都应该从主分支（通常是
master分支）上创建一个单独的分支，以确保项目代码的稳定性。 - 代码编写：在新分支上编写代码。
- 提交到分支：每当代码稳定并可用时，都可以将其提交到所在的分支上。
- 开源协作：如果你在一个团队中工作，那么团队中的其他成员将会在你的存储库中看到提交，并为您提供反馈、评论等等。
- 部署：一旦您的代码合并到主分支上，您就可以将其部署到生产环境中了。
在 GitHub 的官方文档中描述了这种工作方式的好处，它们包括：
- 容易跟踪 — 每个 Pull Request（PR） 都提供了一个本地和远程变更的视图，更容易查看已合并的 PR 和未合并的 Branch，以及无需太多查看单一 commit 视图。
- 更安全 - 强制要求进行 code review ，与 master 分支的改动分离，与测试分离，deploy 分离。
- 更快的迭代 - 不会因为一个长周期分支 block 其他分支的进度，分支起来后提PR，就能交给 CI 系统处理。
虽然这是一种比较成熟的工作流程，但我们在使用 GitHub 的 REST API 时也需要按照这种方式进行操作，否则很容易引起代码冲突的现象。github-flow-js 就是为了让我们更方便的遵循 GitHub Flow 开发的一个 npm 包。
github-flow-js 使用
首先，我们需要在项目中安装 github-flow-js 这个包，可以在终端使用以下命令来进行安装：
npm install github-flow-js
安装完成后，我们就可以进行相关操作了。在使用之前，需要先获取 GitHub API 的访问权限，这可以通过在 GitHub 上创建一个 access token 的方式来实现。具体创建方法可以参考 Creating a personal access token - GitHub Docs 文档。
在获取到 access token 后，我们需要在代码中进行以下配置：
-- -------------------- ---- ------- ----- ---------- - -------------------------- ----- -------- - - ------ ------------------ ----- ------------ ------ -------------- -- ----- ------ - --- ---------------------
其中，owner 代表是 GitHub 用户名，repo 代表仓库名，token 代表访问密钥 token。
进行了上述配置后，我们就可以开始使用该库的一些基本方法，比如获取仓库列表、获取仓库详情、创建 issue 等等。下面给出一些示例代码：
获取仓库列表：
ghFlow.getRepos()
.then((repos) => {
console.log(repos);
})
.catch((err) => {
console.log(err);
});获取仓库详情：
-- -------------------- ---- -------
----- -------- - -
----- ------------
--
-------------------------------
------------ -- -
------------------
--
------------ -- -
-----------------
---创建 issue：
-- -------------------- ---- -------
----- --------- - -
------ ------ -------
----- ------ ------
--
-----------------------------
------------- -- -
-------------------
--
------------ -- -
-----------------
---需要注意的是，github-flow-js 中的所有操作都是异步进行的，因此需要使用 Promise 进行处理。同时，我们需要对接收到的返回值进行解析，以便我们使用其中的数据信息。
总结
通过本文，我们学习了 npm 包 github-flow-js 的使用方法以及了解了 GitHub Flow 工作流程的原理。这种基于分支的工作流程不仅是在 GitHub 上的代码管理中非常实用，而且可以通过其推荐使用方式来规范自己的代码编写流程。希望这篇文章可以帮助到在使用 GitHub REST API 进行开发工作的前端开发者们。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6005663c81e8991b448e23f9