什么是 @wyze/github-release?
@wyze/github-release 是一个 npm 包,用于方便地在 Github 上发布 Release。它基于 octokit/rest.js 开发,并提供了更加简洁的接口和更丰富的功能。
如何安装?
你可以使用 npm 来安装 @wyze/github-release:
npm install -g @wyze/github-release
如何使用?
首先,你需要在 Github 上创建一个 Personal access token,并获得发布 Release 的权限。
然后,你可以在终端中运行以下命令来发布 Release:
wyze-github-release --token=<your_personal_access_token> --owner=<repository_owner> --repo=<repository_name> --tag=<release_tag> --name=<release_name> --body=<release_body> [--assets=<path/to/assets>]
这里解释一下各个参数的含义:
--token
:Personal access token,用于验证身份和授权发布 Release 的权限。--owner
:Github 仓库的 owner。--repo
:Github 仓库的名称。--tag
:Release 的 tag 名称,例如 v1.0.0。--name
:Release 的名称。--body
:Release 的说明文本。--assets
:可选参数,表示要上传到 Release 中的文件路径。可以是一个文件路径,也可以是一个文件夹路径。
案例演示
假设你要发布一个名为 v1.0.0 的 Release,包含以下文件:
- dist/index.js
- dist/index.css
- docs/README.md
- LICENSE
你可以按照以下步骤操作:
第一步:安装 @wyze/github-release
npm install -g @wyze/github-release
第二步:创建 Personal access token
访问 Github Personal access tokens 页面,点击 Generate new token,输入合适的描述和需要的权限,点击 Generate token 即可生成一个 Personal access token。
第三步:发布 Release
在终端中运行以下命令:
wyze-github-release --token=<your_personal_access_token> --owner=<repository_owner> --repo=<repository_name> --tag=v1.0.0 --name="v1.0.0 Release" --body="这是第一个版本的 Release" --assets=dist/index.js --assets=dist/index.css --assets=docs/README.md --assets=LICENSE
这里的参数可以根据你的实际情况进行调整。
总结
@wyze/github-release 是一个非常方便的工具,可以帮助我们快速地发布 Github Release。只需要几个简单的步骤,就可以完成 Release 的发布。如果你是一个开发者,这个工具一定会为你节省不少时间。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/5f2c94d53b0ab45f74a8bb99