共计 2577 个字符,预计需要花费 7 分钟才能阅读完成。
先来看一个场景
在 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 的默认受权,可能获取公有子模块仓库的代码吗?
显然是不能的,如图所示:
fatal
所以,咱们要给 checkout action 进行受权,让它有权限去获取 private submodule
Q: 怎么受权?
A: PAT (personal access token)
增加步骤:Settings -> Developer settings -> Personal access tokens -> Generate new token
同时确保 PAT 有 Full control of private repositories 的能力。
scopes
在获取 token 之后,就能够:
- uses: actions/checkout@v2
with:
# Default: ${{github.token}} , 传参给它更高权限的 token
token: ${{secrets.PERSONAL_TOKEN}}
# 把子模块关上
submodules: 'true'
于是就能在 public 的 action 里轻松的拜访 private 的 repo 了。
success
Workflow dispatch event
下一个问题:
Q: 怎么在公有的 B 仓库里,触发私有的 A 仓库的 Action 呢?
A: REST+PAT 受权,近程调用触发
这个大家都十分相熟了,办法上无非是把 token 作为受权,去调用一个接口,在传参校验胜利之后,action 就跑起来了,大家看到的那些 openapi, 云厂商的 SDK 都是这么做的。
Github 也是如此, 上图。
申明可触发
首先须要在 workflows 文件里,加一行:
on:
workflow_dispatch:
代表此 action 可被 workflow event 触发。
接着就能够进行下一步。
RESTful API
rest api
图上的参数裸露了所有 , 英文曾经解释的十分分明了。
那么咱们触发一个任意仓库里的 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 官网链接