Github Actions: submodule 下公私有仓库授权和通信

Image

Github Actions: submodule 下公私有仓库授权和通信

先来看一个场景

Github 有一个项目 ,简要的结构如下

结构

简单解释一下这张图:

这个项目,由一个公有项目和一个私有项目组成,通过 git submodule 2者之间链接在了一起。

它们都有很多的 Actions , 比如:

  • deploy 负责发布任务。
  • push 负责主动推送link给各大搜索引擎。
  • sync 负责解析 markdown 并通过 md5 摘要比对,同步修改到远程数据库里。
  • action trigger 负责远程触发其他仓库的 action

但是,由图上可知, Actions 是分散在 2 个仓库里的,一个公有,一个私有。它们这些 Actions 如何进行权限验证和通信呢?

在这里, 我主要通过图中橙色那两个箭头 submodule, remote

通过他们对 deploy 这个 action 的影响,来和大家简单的聊聊解决方案。

actions/checkout

checkout 想必是用的最多的 action 之一了

有了它,编写的 workflow 才有权限去访问我们的仓库。

我们往往使用的时候,就写那么一行

- uses: actions/checkout@v2

这一行的默认配置,使用是获取当前 $GITHUB_WORKSPACE 下的仓库文件。

显然它的功能不仅如此,它也可以获取任意仓库,只要我们给它提供授权。

访问私有仓库

由图上可知,我们公有仓库里,附加了一个私有仓库作为子模块。

这时候使用 checkout 的默认授权,能够获取私有子模块仓库的代码吗?

显然是不能的,如图所示:

[图片上传失败...(image-130ea3-1631696944920)]

所以,我们要给 checkout action 进行授权,让它有权限去获取 private submodule

Q: 怎么授权?

A: PAT (personal access token)

添加步骤:Settings -> Developer settings -> Personal access tokens -> Generate new token

同时确保 PATFull control of private repositories 的能力。

[图片上传失败...(image-849d89-1631696944920)]

在获取 token 之后,就可以:

- uses: actions/checkout@v2
  with:
    # Default: ${{ github.token }} ,传参给它更高权限的 token
    token: ${{ secrets.PERSONAL_TOKEN }}
    # 把子模块打开
    submodules: 'true'

于是就能在 publicaction 里轻松的访问 privaterepo 了。

[图片上传失败...(image-ee6f80-1631696944920)]

Workflow dispatch event

下一个问题:

Q: 怎么在私有的B仓库里,触发公有的A仓库的 Action 呢?

A: REST+PAT 授权,远程调用触发

这个大家都非常熟悉了,方法上无非是把 token 作为授权,去调用一个接口,在传参校验成功之后,action 就跑起来了,大家看到的那些 openapi,云厂商的 SDK 都是这么做的。

Github 也是如此, 上图。

声明可触发

首先需要在 workflows 文件里,加一行:

on:
  workflow_dispatch:

代表此 action 可被 workflow event 触发。

接着就可以进行下一步。

RESTful API

[图片上传失败...(image-5aeeca-1631696944920)]

图上的参数暴露了一切 , 英文已经解释的非常清楚了。

那么我们触发一个任意仓库里的 action 就可以这么写:

// 注: 偷懒可以直接使用 `Octokit`
const octokit = new Octokit({
  auth: GITHUB_PERSONAL_TOKEN,
  timeZone: 'Asia/Shanghai',
  baseUrl: 'https://api.github.com'
})
await octokit.rest.actions.createWorkflowDispatch({
    owner: 'sonofmagic',
    ref: 'dev',
    repo: 'icebreaker.top',
    workflow_id: 'blog-deployer.yml'
    // inputs: {
    //   hello: 'world'
    // }
  })

其中 inputs 这个可选参数,是可以用作 action yml文件本身的逻辑判断的。

这里展示一下它的用法和校验:

name: Manually triggered workflow
on:
  workflow_dispatch:
    inputs:
      name:
        description: 'Person to greet'
        required: true
        default: 'Mona the Octocat'
      home:
        description: 'location'
        required: false
        default: 'The Octoverse'

jobs:
  say_hello:
    runs-on: ubuntu-latest
    steps:
      - run: |
          echo "Hello ${{ github.event.inputs.name }}!"
          echo "- in ${{ github.event.inputs.home }}!"

看到上面这段代码,是不是瞬间理解了,inputs 参数是什么?怎么用?

当然除了 Workflow dispatch event 这种触发方式,还有 Repository dispatch event 不过,那个值得以后单独聊。

后记

想搞 monorepo : lerna, workspace ,submodule 等等解决方案很多。

CI/CD 的解决方案也很多,各种写法,各种文档,API 不尽相同。

写前端,客户端,app,解决方案也很多。

我们程序员在学习中,能够体会到本质,举一反三,便是最好的状态。

附录

源码

RESTful API官方链接

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

推荐阅读更多精彩内容