本文將介紹如何使用 GitHub Actions 部署前端靜態頁面，以及如何自己創建一個 Docker 容器 Action，
簡介 Actions
GitHub Actions 是 GitHub 官方推出的持續集成/部署模塊服務（CI/CD），和 jenkins、Travis CI 是同一類產品定位，
但 Actions 的最大優勢，就是它是與 GitHub 高度整合的，只需一個組態檔即可自動開啟服務，甚至你不需要購買服務器 —— GitHub Actions 自帶云環境運行，包括私有倉庫也可以享用，而且云環境性能也十分強勁，
當然這也意味著專案必須存放在 GitHub 才能享受這項服務，如果你的 GitHub 上有一些專案需要部署，那不妨把構建、上傳等作業放到 Actions 里，比如最近我有個前端專案需要打包成靜態檔案，然后上傳到騰訊云 COS 里，這是典型的自動化部署應用場景，我們可以借助 Actions 實作一勞永逸，
配置 workflow
前文說到，開啟 GitHub Actions 只需一個組態檔，這個檔案就是 workflow（作業流），它需要存在倉庫目錄下 .github/workflows/*.yml，檔案名任意，但需要是一個 YAML 組態檔，
這個檔案用來規定自動化操作在什么時候觸發啟動，然后需要做哪些事情，比如這樣：
name: Deploy
on:
push:
branches:
- master
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout master
uses: actions/checkout@v2
with:
ref: master
- name: Setup node
uses: actions/setup-node@v1
with:
node-version: "10.x"
- name: Build project
run: yarn && yarn build
- name: Upload COS
uses: zkqiang/tencent-cos-action@master
with:
args: delete -r -f / && upload -r ./dist/ /
secret_id: ${{ secrets.SECRET_ID }}
secret_key: ${{ secrets.SECRET_KEY }}
bucket: ${{ secrets.BUCKET }}
region: ap-shanghai
首先配置里所有 name 都是可以自定義的，只是用于可視化中進行識別，
on: 用來指定啟動觸發的事件，push 則表示在監聽到 git push 到指定分支時觸發，如此之外還可以是 pull_request，
jobs: 是作業任務，可以包含多個 job，并且每個 job 是獨立的虛擬環境，不同 job 之間默認是并行的，如果想順序執行，可以這樣 build-job: needs: test-job，
runs-on: 用來指定執行系統環境，不僅有常用的 Linux 發行版，還可以是 macOS 或 Windows，
steps: 表示每個 job 需要執行的步驟，比如這里我分成了四步：拉取分支 → 安裝 Node 環境 → 構建專案 → 上傳 COS，
uses: 指的是這一步驟需要先呼叫哪個 Action，
Action 是組成作業流最核心最基礎的元素，每個 Action 可以看作封裝的獨立腳本，有自己的操作邏輯，我們只需要 uses 并通過 with 傳入引數即可，
比如 actions/checkout@v2 就是官方社區貢獻的用來拉取倉庫分支的 Action，你不需要考慮安裝 git 命令工具，只需要把分支引數傳入即可，
更多 Action 你可以通過 GitHub 頂部的 Marketplace 里找到，不過問題來了，我在其中搜索騰訊 COS 并沒有找到相關 Action，
騰訊官方提供了 coscmd 命令列工具，是基于 Python 開發，很可惜沒有二進制版本，因此如果使用在 Actions 中，就必須有 Python 環境，有兩種思路：
- 在 Steps 里加入
actions/setup-python這一步驟安裝 Python 環境，然后再使用pip install coscmd； - 將上面的步驟封裝成獨立的 Action，之后直接
uses即可，
第一種很簡單，可以在 steps 里加入：
steps:
- uses: actions/setup-python@v1
with:
python-version: '3.x'
architecture: 'x64'
- name: Install coscmd
run: pip install -U coscmd
- name: Upload COS
run: |
coscmd config ....
coscmd upload -r ./dist/ /
但是我選擇了第二種，順便了解如何創建自己的 Action，
創建 Docker 容器 Action
官方提供了兩種方式創建 Action，一種是使用 JavaScript 環境創建，另一種是通過 Docker 容器創建，coscmd 既然依賴 Python，這里使用 Docker 容器更簡單一些，
創建 Dockerfile
那我們首先創建一個 Dockerfile:
FROM python:3.7-slim
ENV PYTHONDONTWRITEBYTECODE 1
ENV PYTHONUNBUFFERED 1
RUN pip install --upgrade --no-cache-dir coscmd
COPY "entrypoint.sh" "/entrypoint.sh"
RUN chmod +x /entrypoint.sh
ENTRYPOINT ["/entrypoint.sh"]
如果不了解 Docker 也沒關系，只需要知道 FROM 是指定容器環境，然后 RUN 去執行 pip install coscmd 的操作，最后將倉庫目錄下的 entrypoint.sh 拷貝到容器中，并用 ENTRYPOINT 執行，至于這個 sh 檔案后面再說 ，
創建 action.yml
這里定義了 Action 相關的配置：
name: 'Tencent COS Action'
description: 'GitHub Action for Tencent COS Command'
author: 'zkqiang <[email protected]>'
branding:
icon: 'cloud'
color: 'blue'
inputs:
args:
description: 'COSCMD args'
required: true
secret_id:
description: 'Tencent cloud SecretId'
required: true
secret_key:
description: 'Tencent cloud SecretKey'
required: true
bucket:
description: 'COS bucket name'
required: true
region:
description: 'COS bucket region'
required: true
runs:
using: 'docker'
image: 'Dockerfile'
除了一些描述性資訊，最重要的是定義 input: args 輸入引數，也就是 step 里 with 傳遞的引數，可以通過 required 設定該引數是否必傳，這里傳遞的引數都是識別和驗證物件桶的必需引數，
最后通過 runs 指定 docker 環境和 Dockerfile 檔案，
創建 entrypoint.sh
這里需要使用 shell 來寫傳遞引數后的執行邏輯，由于 coscmd 本身就是命令列工具，所以我們只需將引數再傳給它即可，
#!/bin/bash
set -e
if [ -z "$INPUT_ARGS" ]; then
echo 'Required Args parameter'
exit 1
fi
# ...省略部分代碼
coscmd config -a $INPUT_SECRET_ID -s $INPUT_SECRET_KEY -b $INPUT_BUCKET -r $INPUT_REGION -m $THREAD
IFS="&&"
arrARGS=($INPUT_ARGS)
for each in ${arrARGS[@]}
do
unset IFS
each=$(echo ${each} | xargs)
if [ -n "$each" ]; then
echo "Running command: coscmd ${each}"
coscmd $each
fi
done
action.yml 中的引數會自動轉成 INPUT_ 前綴并且大寫的變數傳入，因此我們可以直接參考，
驗證完引數之后（也可省略，action.yml 已判斷），先配置 coscmd config，然后將 args 引數傳入 coscmd 即可，另外為了方便使用多條命令，加入了支持 && 連接命令，腳本里需要對其分割，
呼叫自建的 Action
將剛才創建的 Action 推送到 GitHub 上，就呼叫這個 Action 了，前文的 workflow 配置里也已經包含了：
name: Upload COS
uses: zkqiang/tencent-cos-action@master
with:
args: delete -r / && upload -r ./dist/ /
secretId: ${{ secrets.SECRET_ID }}
secretKey: ${{ secrets.SECRET_KEY }}
bucket: ${{ secrets.BUCKET }}
region: ap-shanghai
args: delete -r -f / && upload -r ./dist/ /，相當于先清空物件桶，然后再執行上傳，delete 和 upload 都是 coscmd 自己的命令引數，其他命令可以查閱官方檔案，
另外有沒有注意到 ${{ secrets.XXX }} 這種引數，并不是具體的值，而是呼叫了 GitHub Settings 里保存的 secrets，添加方式如下：
為什么這樣做？是因為 workflow 代碼在公開倉庫中也是任意可見的，如果將 SecretKey 這些資訊暴露，等于將 COS 操作權限交出，而存在 settings 里則不會有這個問題，
然后就可以使用 Actions 功能了，向包含 workflow 的倉庫 master 分支推送一次代碼，如果沒有配錯的話，過段時間可以在 Actions 欄里看到一列綠色的對號，
結語
至此我們了解了如何使用 GitHub Actions 部署，以及如何自己創建一個 Action，可見這一項免費的服務真的非常好用，借助 Action 開源市場也可以大幅簡化使用，
當然 CI 的應用不僅僅在部署這方面，絕大部分從開發完成到交付/部署之間的動作也都可以用自動化完成，只要是重復的操作就應該考慮能不能加入自動化來解放雙手，
本文 COS Action 的代碼倉庫，
workflow 官方檔案
更多的 Actions 可以從 Marketplace 和 awesome-actions 里獲取，
本文屬于原創，首發于微信公眾號「面向人生編程」，如需轉載請后臺留言，
關注后回復以下資訊獲取更多資源
回復【資料】獲取 Python / Java 等學習資源
回復【插件】獲取爬蟲常用的 Chrome 插件
回復【知乎】獲取最新知乎模擬登錄
轉載請註明出處，本文鏈接：https://www.uj5u.com/qita/17766.html
標籤：其他
上一篇：一個按鍵搞定日常git操作