ARTICLE DETAIL

资讯详情

深耕网站建设与运营推广的一线实战洞察。

GitHub CLI 如何用 gh repo autolink create 配置外部跟踪系统的 Issue 自动链接?

GitHub CLI 如何用 gh repo autolink create 配置外部跟踪系统的 Issue 自动链接? GitHub CLI 如何用 gh repo autolink create 配置外部跟踪系统的 Issue 自动链接【免费下载链接】cliGitHub’s official command line tool项目地址: https://gitcode.com/GitHub_Trending/cli/cli当团队的 Issue、Pull Request、commit message 或 release 描述里写有外部跟踪系统如 Jira 之类的键值时GitHub 的 autolink 功能可以让这些文本自动变成指向外部系统的链接。通过 GitHub CLI 的gh repo autolink create命令可以不改网页设置页直接在仓库上创建这条自动链接规则。注意autolink 的查看和管理都需要仓库admin角色命令会在目标仓库上创建一条新记录。命令格式与两个必需参数命令语法为new是它的别名gh repo autolink create keyPrefix urlTemplate两个位置参数都必须提供否则命令会直接报错Cannot create autolink: keyPrefix and urlTemplate arguments are both requiredkeyPrefix指定一个前缀当该前缀后紧跟特定字符时就会生成链接。urlTemplatekeyPrefix被匹配到时生成的目标 URL其中必须包含num变量用来替换实际的引用编号。如果模板中出现多处num只有第一处会被替换。autolink 默认是 alphanumeric字母数字类型加--numeric标志短形式-n则创建 numeric 类型。两种类型下num匹配的行为不同alphanumeric匹配A-Z不区分大小写、0-9、-numeric只匹配0-9。创建 alphanumerical 与 numeric 两种链接命令帮助文档给出的两个示例分别覆盖了默认类型和 numeric 类型# Create an alphanumeric autolink to example.com for the key prefix TICKET-. # Generates https://example.com/TICKET?query123abc from TICKET-123abc. $ gh repo autolink create TICKET- https://example.com/TICKET?querynum # Create a numeric autolink to example.com for the key prefix STORY-. # Generates https://example.com/STORY?id123 from STORY-123. $ gh repo autolink create STORY- https://example.com/STORY?idnum --numeric这两条是文档示例实际使用时把前缀和 URL 换成你自己跟踪系统的值即可num是模板变量不要替换成具体数字。命令成功时输出如下其中 ID 和仓库名是实际值下面以测试用例中的示例展示✓ Created repository autolink 1 on OWNER/REPO默认在当前目录所在的仓库上执行。不在 git 仓库目录内、或想操作其他仓库时用--repo标志指定格式为[HOST/]OWNER/REPOgh repo autolink create --repo OWNER/REPO TICKET- https://example.com/TICKET?querynum--repo也可以写成HOST/OWNER/REPO用于 GHES 等其他主机。验证链接是否配置成功创建成功后可以用list子命令确认。默认按表格输出ID、KEY PREFIX、URL TEMPLATE、ALPHANUMERIC四列仓库没有任何 autolink 时会提示no autolinks found in OWNER/REPOgh repo autolink list --repo OWNER/REPO也可以只取keyPrefix字段做脚本化检查acceptance 测试就是这样核对的gh repo autolink list --repo OWNER/REPO --jsonkeyPrefix --jq.[].keyPrefix输出包含TICKET-即说明配置已生效。拿到 autolink 的 ID 后可用list --jsonkeyPrefix,id查询用view核对 URL 模板是否原样保存gh repo autolink view --repo OWNER/REPO id --jsonurlTemplate --jq.urlTemplateid替换为你查到的数字 ID。此外gh repo autolink list --web会在浏览器中打开仓库的settings/key_links页面适合用网页再确认一遍。常见报错缺少参数漏掉keyPrefix或urlTemplate任一个报Cannot create autolink: keyPrefix and urlTemplate arguments are both required。权限不足请求返回 404 时CLI 会把错误信息改写为Must have admin rights to Repository.。这对应文档说明的autolink 需要 admin 角色此时应找仓库管理员执行。其他创建失败会包装为error creating autolink: 具体原因。收尾删除这条 autolink如果前缀配错或不再需要用delete子命令删除--yes跳过确认gh repo autolink delete --repo OWNER/REPO id --yes删除后再次运行list确认列表中不再出现该 ID。完整的创建→验证→删除流程可参考仓库中的验收测试 acceptance/testdata/repo/repo-autolink.txtar命令定义在 pkg/cmd/repo/autolink/create/create.go 和 pkg/cmd/repo/autolink/autolink.go。【免费下载链接】cliGitHub’s official command line tool项目地址: https://gitcode.com/GitHub_Trending/cli/cli创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考
返回列表