使用 github cli 加速与 github 的交互

由于我目前的所有开发流程一方面和 github 有密切的关联,另一方面又大量的使用 vim iTerm 这样的工具,因此有很强烈的诉求希望可以更好的集成这些工具,最近刚刚尝试了下 github 官方的 cli 工具 感觉确实可以满足我这方面的需求。这里记录下我自己常用的一些命令。

常用的工作流程

我目前高频使用 github 如下的一些功能:

  1. 所有的仓库都在 github 里,会创建新的仓库,然后 clone 到本地,或者将本地新创建的仓库在 github 那边对应创建远程仓库
  2. 在 github 创建 issue 并尽量让自己所提交的 commit 和 issue 绑定
  3. 使用 github actions 去执行 ci 流程、构建镜像、打 tag、 做 release

针对这些场景,github cli 都有对应的功能点,下面一一罗列。

快速打开 github 仓库页面

gh browse

为当前目录的仓库创建 github repo

gh repo create <org>/<repo-name> --source . --private

快速创建 issue

个人认为 issue 就是软件开发行业 GTD 的最小单元,原则上超过 5 分钟才能做完的事情都应该有个 issue 与之对应,这样才能将实际的工作更好的反馈到整个项目里。当为了鼓励大家写 issue,issue 的编写是越快越好、越方便越好。gh 就很好的提升了 issue 编写的速度。

gh issue create --title "xxx"

这个工具做的非常细致,在创建 issue 时甚至会要求你去选择 issue template:

然后会问你是否需要编辑内容:

如果要编辑内容会自动的帮你引入模板:

这里我默认的编辑器是 newovim 在这里编辑可以用到 autopilot 在内的全套 vim 插件,也会大大提升我编辑 issue 的速度。

github actions 的快捷流程

github actions 用到的命令比较多,但都很简单。

查看运行的 github workflow

gh run watch

gh 会让你选择当前正在运行的 workflow 。

查看运行的 workflow 的结果

这么做的场景一般有两个:

  1. 查看列表,确认 action 是跑完了还是没跑完,成功了还是失败了

    gh run list
    
  2. 一些 action 执行完会有一些输出,比如会打个镜像并且暴露镜像的 tag,我需要获取这个 tag

    gh run view <action-id>
    

触发 workflow 执行

有些 workflow 是需要主动触发的,可以去 github 网页上触发,但是更方便的方法就是通过命令行工具触发:

# 触发 graphql.yml 的 workflow 并提供参数 `environment=prod`
gh workflow run graphql.yml -f environment=prod

# 触发 bump_version.yml 的 workflow 并提供参数 `version=patch`
gh workflow run bump_version.yml -f version=patch
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,530评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 86,403评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,120评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,770评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,758评论 5 367
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,649评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,021评论 3 398
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,675评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,931评论 1 299
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,659评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,751评论 1 330
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,410评论 4 321
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,004评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,969评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,203评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,042评论 2 350
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,493评论 2 343

推荐阅读更多精彩内容