CI/CD(Github Action)

CI/CD

大多數企業採用敏捷開發,而在程式上傳到伺服器的過程中需要經過許多步驟,因此我們可以透過自動化來減少在一連串步驟中的人為疏失,並加速整體開發流程。解決人類懶惰的天性

何謂CI/CD

  • CI(Continuous integration)持續整合or自動化整合
    將開發至一個階段性的程式碼(通常是版本控制的一個commit)經由自動化工具測試(Unit test),協助檢查程式碼問題並建置出佈署的版本。

  • CD (Continuous Deployment)持續部署or自動化佈署
    將測試通過的代碼自動部署到伺服器上,縮短部署的時間,減少了為錯誤。好的CD包含監控系統進行服務存活檢查,並在發生異常時主動通知開發人員。

常見CI/CD工具

架設在本地端

  • Jenkins: 最古老的工具
    • 優點:能夠自行編寫插件達成各式各樣功能
    • 缺點:學習成本高、維護不易、設定檔難撰寫
  • Drone: 近年新出的工具,用Golang開發,會自動建立Docker執行流程並在完成後刪除
    • 優點:較易學習、建置速度快、容量小、所有流程都在Docker內完成
    • 缺點:套件不多

雲端

  • GitLab CI: 只能使用在GitLab
  • GitHub Action: 相對年輕的工具,只能用在Github
    • 優點:與 Github 相容性極佳、易於使用、免費、開放性、靈活性
    • 缺點:權限設置較為複雜、環境變數(secrets, variables)只能由Repo擁有者設定

GitHub Action

在現代軟體開發中,CI/CD是必不可少的流程,而Github Action則是一個相當熱門的工具,可以協助開發者打造自動化的CI/CD流程。接下來將會介紹什麼是Github Action,以及如何使用它來自動化你的軟體開發流程。

什麼是Github Action?

Github Action是一個基於事件驅動的自動化工具,它可以在你的Github repository中註冊一些行為,在某些事件發生時執行一些動作,例如:自動化測試、自動化部署等等。Github Action的核心是一個YAML語言的配置文件,你可以在其中定義工作流程、觸發事件、環境變數、依賴關係等等。Github Action是一個強大的工具,它可以大幅簡化軟體開發流程,同時也可以提升開發效率和品質。

核心概念

在使用 Github Action 之前,需要了解一些基本概念。Github Actions 由四個元素組成,範圍由大至小為:



graph LR;
id1(Workflow) -.-> id2(Job) -.-> id3(Step) -.-> id4(Actions/command)

  • Workflow:整個CI/CD運行一次的流程,定義了一系列的工作,以執行特定的任務,當中可能包含多個 Job。
  • Job:任務,工作流程中的單個任務。一個Workflow可能有一至多個 Job 組成。
  • Step:步驟,工作流程中的一個操作,一個 Job 由一至多個 Step 組成。
  • Actions/commands:命令或動作,是Github Action的最小元素,用於執行一個特定的操作,例如:構建、測試、部署等等。動作可以是內置的或來自第三方。

另外需要了解的是 Event:

  • Event:事件,是觸發工作流程的觸發器,例如:程式碼提交、Pull Request等等。

如何使用Github Action?

使用Github Action非常簡單,只需要在Github倉庫中創建.github/workflows目錄,然後在其中添加YAML文件即可。通常使用 config 類型的語法都是千變萬化的,以下使用一個簡單的範例來解釋:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
name: Go-test # 可自行定義,主要目的是要能看出哪個workflow在執行

on:
push:
branches: [ "master" ]
workflow_dispatch:
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3

- name: Set up Go
uses: actions/setup-go@v3
with:
go-version: 1.19

- name: Build
run: go build -v ./...

- name: Test
run: go test -v ./...
deploy:
name: Deploy
runs-on: ubuntu-latest
environment: production

steps:
- name: Checkout
uses: actions/checkout@v3

- name: Configure AWS credentials
uses: aws-actions/configure-aws-credentials@v1
with:
aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
aws-region: ${{ env.AWS_REGION }}
...
  • name:這個workflow的名子,省略時預設為.yml的檔名

  • on:workflow的觸發條件,可以設定多種條件。以此範例來說,設定了一個push條件,並且指定只有 push 到master這個branch才會出發,另外還設定workflow_dispatch 來讓我們能夠直接手動觸發。除此之外還有許多的觸發條件,詳細請參考 文件

  • jobs:在本範例中有 build 和 deploy 兩個job

    • name:幫job另外取名,如果不寫的話會直接使用build和deploy來作為job名稱
    • runs-on:指定要運行的環境,通常多使用ubuntu,當然也可以選擇windows或macOS。由於指定的內容為docker image,因此也看過直接使用其他image來作環境的使用方法,但我自己沒有測試過。當然也可以自行製作運行環境,詳細請參考 文件

    所有job會同時執行,除非寫上條仵needs或if,讓jobs之間產生依賴關係就可以指定執行順序,例如:

    1
    2
    3
    4
    5
    6
    jobs:
    job1:
    job2:
    needs: job-1
    job3:
    needs: [job1, job2]

    在上面這個情況下, job2 會等待 job1 執行完成後才執行, job3 則會等待 job1 和 job2 完成,因此執行順序就會是 job1 –> job2 –> job3。

  • steps:真正定義workflow需要執行的指令

    • name:一樣是幫step取名,不寫時預設為 Run 加上 users的名稱,例如Run actions/checkout@v3,為了未來能夠清楚了解此步驟在做什麼,建議一律都命名。
    • uses:使用別人寫好的actions,可以在github的marketplace搜尋,例如本專案中的 actions/checkout@v3 就是使用官方提供的action,此步驟在大部分的job內都需要填寫,他會把Repo中的程式碼複製到虛擬主機中。

      ng no-icon

      這也是Github Actions的特色之一,透過重複使用step來減少重複撰寫相同的config檔,除了遵照DRY原則也增加可讀性與可維護性。

    • run:在沒有使用預先寫好的steps時,可以使用run指令來下bash指令,每一個指令就是一個action。

另外在範例中可以看到使用secrets.AWS_ACCESS_KEY_ID和env.AWS_REGION,此類變數可以在 Settings 中的 secrets and variables 設定。

帳號密碼請勿寫在.yml檔內,所有能看到repository的人都能看到。

  • 一般變數可設定在Enviroment Variables
    • 在workflow中會以明碼顯示
  • 敏感資訊可設定在Secrets
    • 在workflow中會遮蔽部分文字

上面兩項只有repository owner能設定。



參考資料

CICD到底是什麼呢|全網最詳解