npm 包 github-publish-release 使用教程

在开发前端项目的过程中，我们经常会需要将代码发布到 GitHub 上以便于分享、协作等。而 github-publish-release 就是一个可以帮助我们快速上传、发布 GitHub Release 的 npm 包。本文将详细介绍如何使用该工具。

安装

首先，我们需要全局安装 github-publish-release：

npm install -g github-publish-release

配置

接着，在使用之前，我们需要在 GitHub 上生成 Personal access token。具体方法如下：

1. 进入 https://github.com/settings/tokens；
2. 点击 Generate new token；
3. 填写 token 名称和勾选 repo 权限；
4. 点击 Generate token。

得到 Personal access token 后，我们还需要创建 .github-publish-release.json 文件来存储配置信息：

{
  "owner": "your_username",
  "repo": "your_repository",
  "token": "your_personal_access_token"
}

修改其中的 owner 和 repo 为你的 GitHub 用户名和仓库名称，token 则填写上一步得到的 Personal access token。

发布 Release

接下来，我们就可以使用 github-publish-release 来发布新的 Release 了。命令格式如下：

github-publish-release <version> [options]

其中 <version> 为需要发布的版本号，例如 v1.0.0。

以下是一些常用的参数：

• --name: Release 的名称；
• --body: Release 的正文内容；
• --assets: 要上传的文件列表，可以是单个或多个，例如 file1.txt file2.txt。

示例：

github-publish-release v1.0.0 --name "First release" --body "This is the first release." --assets dist/*

这条命令会创建一个名为 v1.0.0 的 Release，并将 dist/ 目录下的所有文件作为附件上传。

总结

通过本文的介绍，我们了解了如何安装和配置 github-publish-release，并使用其发布新的 GitHub Release。希望本文能够对前端开发者有所帮助。

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/48738