5 个版本
0.1.9 | 2021 年 3 月 22 日 |
---|---|
0.1.8 | 2021 年 3 月 16 日 |
#651 在 配置
32KB
601 行
gh-labels-cli
管理您的 GitHub 标签的工具。
用例
我个人在 GitHub 上初始化新仓库时,使用 CLI 创建标准标签集。我为 gh
创建了自定义别名,它使用 gh-labels-cli
来创建仓库并运行 CLI 进行批量标签创建
$ gh alias set -s new 'gh repo create $1; cd $1; gh labels update --purge'
- Adding alias for new: gh repo create $1; cd $1; gh labels update --purge
✓ Changed alias new from !gh repo create $1; cd $1; gh labels update to !gh repo create $1; cd $1; gh labels update --purge
安装
目前,gh-labels-cli
只能通过 cargo
安装
$ cargo install gh-labels-cli --locked
正在开发 homebrew tab 和 AUR 软件包 :)
使用方法
CLI 可以作为独立程序直接通过 gh-labels
二进制文件调用,或者您可以为官方 GitHub CLI (gh
) 注册别名以将 gh-labels-cli
集成到其中。
要注册别名,请运行 gh-labels integration install
。
CLI 需要一个具有适当的 public_repo
或 repo
范围的个人访问令牌,具体取决于您是否希望它在私有仓库上也能工作。令牌可以通过 CLI 参数或通过环境变量 GH_LABELS_TOKEN
传递给 CLI。
注意:有些人可能希望在不同 CLI 中重用单一令牌。我遇到的 CLI 常常使用
GITHUB_TOKEN
环境变量。这也得到了支持。尝试读取令牌的顺序是CLI 参数
>GH_LABELS_TOKEN
>GITHUB_TOKEN
。
CLI 在仓库上操作。这些仓库可以通过形式为 owner/repo
的参数直接提供,或者通过在指向 github.com
的 origin
上游命名的现有 git 仓库中运行 CLI 来提供。
更多信息,请查看帮助。
我现在使用 gh new <repo-name>
别名来创建新仓库,而不是 gh repo create
。
命令
配置
用于查询配置文件路径、内容或在终端中编辑配置。
集成
用于安装和卸载为 gh
CLI 的 labels
别名。
API
与实际 GitHub API 调用相关的命令。
创建
在仓库中创建具有给定值的单个标签。
更新
批量创建标签并更新仓库中现有的标签。您必须提供用于命令执行的 标签定义文件。文件可以通过 -f,--file
参数或通过将文件放入通过 gh-labels config --path
返回的目录中来提供。使用第二种选项时,文件必须命名为 labels.json
。
标签定义文件
标签定义文件是一个包含您想要应用到仓库中的所有标签的文件。它是一个具有以下格式的 JSON 文件
{
"labels": [
{
"name": "type: bug",
"color": "431232",
"description": "A programming error"
}
]
}
注意:描述字段是可选的。
我的标签定义文件可以在 这里 找到。
许可证
根据您的选择,许可协议为 Apache License, Version 2.0 或 MIT 许可证。除非您明确声明,否则根据 Apache-2.0 许可证定义的,您提交的任何贡献,旨在包含在作品中,都应如上所述双重许可,不附加任何额外条款或条件。
依赖项
~33–52MB
~1M SLoC