前言
我前面 vuepress搭建了一个静态博客,挂在了Github pages和Coding pages上面。
coding pages在国内的访问速度比github pages要快很多,而且还可以被百度收录。
一开始的部署方式是使用sh部署脚本把代码提交到这两个平台的仓库分支,虽然已经很方便了,但是我还想把博客未打包的源码提交到Github主分支上。这就需要我操作两次命令,我就想能不能只需要一次操作就可以同时把源码、部署代码一次性提交到两个平台呢?
实现
在了解GitHub Actions最近(2019.12)刚正式发布了之后,尝试使用它发现能够满足我的需求。GitHub Actions 入门教程
首先,需要获取token,后面会用到。获取方法:github获取token官方文档、coding获取token官方文档。
然后,将这两个token同时储存到github仓库的Settings/Secrets
里面。变量名可以随便取,但是注意要和后面的ci.yml
文件内的变量名一致,这里取的是ACCESS_TOKEN
和CODING_TOKEN
。
GitHub Actions 的配置文件叫做 workflow 文件,存放在代码仓库的.github/workflows
目录。
workflow 文件采用 YAML 格式,文件名可以任意取,但是后缀名统一为.yml
,比如ci.yml
。一个库可以有多个 workflow 文件。GitHub 只要发现.github/workflows
目录里面有.yml
文件,就会自动运行该文件。
我的ci.yml
文件:
name: CI # 在master分支发生push事件时触发。 on: push: branches: - master jobs: # 工作流 build: runs-on: ubuntu-latest #运行在虚拟机环境ubuntu-latest strategy: matrix: node-version: [10.x] steps: - name: Checkout # 步骤1 uses: actions/checkout@v1 # 使用的动作。格式:userName/repoName。作用:检出仓库,获取源码。 官方actions库:https://github.com/actions - name: Use Node.js ${{ matrix.node-version }} # 步骤2 uses: actions/setup-node@v1 # 作用:安装nodejs with: node-version: ${{ matrix.node-version }} # 版本 - name: run deploy.sh # 步骤3 (同时部署到github和coding) env: # 设置环境变量 GITHUB_TOKEN: ${{ secrets.ACCESS_TOKEN }} # toKen私密变量 CODING_TOKEN: ${{ secrets.CODING_TOKEN }} # 腾讯云开发者平台(coding)私密token run: npm install && npm run deploy # 执行的命令 # package.json 中添加 "deploy": "bash deploy.sh"
这个配置文件会在我push提交代码到主分支时触发工作,运行环境是ubuntu-latest
,工作步骤:
- 一,获取仓库源码
- 二,安装nodejs,打包项目有用到nodejs
- 三,把token设置到环境变量,安装项目依赖,并运行
deploy.sh
文件,
ACCESS_TOKE 和 CODING_TOKEN 都是保存在github仓库的
Settings/Secrets
位置的私密变量,仓库代码中可以通过<secrets.变量名>来获取,保证了token的私密性。
再来看看将要被运行的deploy.sh
部署代码:
#!/usr/bin/env sh # 确保脚本抛出遇到的错误 set -e npm run build # 生成静态文件 cd docs/.vuepress/dist # 进入生成的文件夹 # deploy to github echo 'blog.xugaoyi.com' > CNAME if [ -z "$GITHUB_TOKEN" ]; then msg='deploy' githubUrl=git@github.com:xugaoyi/blog.git else msg='来自github action的自动部署' githubUrl=https://xugaoyi:${GITHUB_TOKEN}@github.com/xugaoyi/blog.git git config --global user.name "xugaoyi" git config --global user.email "894072666@qq.com" fi git init git add -A git commit -m "${msg}" git push -f $githubUrl master:gh-pages # 推送到github # deploy to coding echo 'www.xugaoyi.com\nxugaoyi.com' > CNAME # 自定义域名 if [ -z "$CODING_TOKEN" ]; then # -z 字符串 长度为0则为true;$CODING_TOKEN来自于github仓库`Settings/Secrets`设置的私密环境变量 codingUrl=git@git.dev.tencent.com:xugaoyi/xugaoyi.git else codingUrl=https://xugaoyi:${CODING_TOKEN}@git.dev.tencent.com/xugaoyi/xugaoyi.git fi git add -A git commit -m "${msg}" git push -f $codingUrl master # 推送到coding cd - rm -rf docs/.vuepress/dist
这个文件使用Shell命令写的,它会先运行打包命令,进入打包好的文件,创建一个自定义域名的CNAME文件(如果你没有自定义域名可去掉这个命令),判断是否有token环境变量,如果没有说明是在本地自己的电脑上运行的部署,使用ssh代码仓库地址,如果有token环境变量,说明是GitHub Actions自动触发的部署,此时使用的是可以通过toKen来获取代码提交权限的提交地址。最后通过git命令提交到各自的仓库,完成部署。
提示:
- Shell 可以获取到环境变量。
- 我想给两个平台上部署的博客不一样的自定义域名,因此做了分开创建CNAME文件,分开提交。
至此,我前面提到的需求就实现啦,只需要把源码push到github仓库这一个步骤,后面的博客打包、部署到github和coding等工作都由GitHub Actions来自动完成。
如下你想查看部署日志,你可以到github仓库的Actions这一项查看。