越寫悅快樂之Vue項目如何使用GitHub Actions進行自動發佈

今天的越寫悅快樂之系列文章爲大家帶來Vue項目如何使用GitHub Actions進行自動發佈。衆所周知,GitHub已經成爲全世界碼農進行學習的朝聖之地,衆多的開源項目在GitHub上進行分享和分發,讓我們一起來探索GitHub的奧祕吧。

GitHub Actions是什麼(What)

GitHub Actions 是 GitHub 的持續集成服務,於2018年10月推出。

大家知道,持續集成由很多操作組成,比如抓取代碼、運行測試、登錄遠程服務器,發佈到第三方服務等等。GitHub 把這些操作就稱爲 actions。

很多操作在不同項目裏面是類似的,完全可以共享。GitHub 注意到了這一點,想出了一個很妙的點子,允許開發者把每個操作寫成獨立的腳本文件,存放到代碼倉庫,使得其他開發者可以引用。

如果你需要某個 action,不必自己寫複雜的腳本,直接引用他人寫好的 action 即可,整個持續集成過程,就變成了一個 actions 的組合。這就是 GitHub Actions 最特別的地方。

GitHub 做了一個官方市場,可以搜索到他人提交的 actions。另外,還有一個 awesome actions 的倉庫,也可以找到不少 action。

GitHub Actions的應用場景(Where)

  • GitHub上的項目都可以使用

GitHub Actions的基本概念(What)

  • workflow (工作流程):持續集成一次運行的過程,就是一個 workflow。

  • job (任務):一個 workflow 由一個或多個 jobs 構成,含義是一次持續集成的運行,可以完成多個任務。

  • step(步驟):每個 job 由多個 step 構成,一步步完成。

  • action (動作):每個 step 可以依次執行一個或多個命令(action)。

workflow 文件

GitHub Actions 的配置文件叫做 workflow 文件,存放在代碼倉庫的.github/workflows目錄。

workflow 文件採用 YAML 格式,文件名可以任意取,但是後綴名統一爲.yml,比如foo.yml。一個庫可以有多個 workflow 文件。GitHub 只要發現.github/workflows目錄裏面有.yml文件,就會自動運行該文件。

workflow 文件的配置字段非常多,詳見官方文檔。下面是一些基本字段。

(1)name

name字段是 workflow 的名稱。如果省略該字段,默認爲當前 workflow 的文件名。

name: GitHub Actions Demo

(2)on

on字段指定觸發 workflow 的條件,通常是某些事件。

on: push

上面代碼指定,push事件觸發 workflow。

on字段也可以是事件的數組。

on: [push, pull_request]

上面代碼指定,push事件或pull_request事件都可以觸發 workflow。

完整的事件列表,請查看官方文檔。除了代碼庫事件,GitHub Actions 也支持外部事件觸發,或者定時運行。

(3)on.<push|pull_request>.<tags|branches>

指定觸發事件時,可以限定分支或標籤。

on:
 push:
   branches:    
     - master

上面代碼指定,只有master分支發生push事件時,纔會觸發 workflow。

(4)jobs.<job_id>.name

workflow 文件的主體是jobs字段,表示要執行的一項或多項任務。

jobs字段裏面,需要寫出每一項任務的job_id,具體名稱自定義。job_id裏面的name字段是任務的說明。

jobs:
  my_first_job:
    name: My first job
  my_second_job:
    name: My second job

上面代碼的jobs字段包含兩項任務,job_id分別是my_first_jobmy_second_job

(5)jobs.<job_id>.needs

needs字段指定當前任務的依賴關係,即運行順序。

jobs:
  job1:
  job2:
    needs: job1
  job3:
    needs: [job1, job2]

上面代碼中,job1必須先於job2完成,而job3等待job1job2的完成才能運行。因此,這個 workflow 的運行順序依次爲:job1job2job3

(6)jobs.<job_id>.runs-on

runs-on字段指定運行所需要的虛擬機環境。它是必填字段。目前可用的虛擬機如下。

  • ubuntu-latestubuntu-18.04ubuntu-16.04
  • windows-latestwindows-2019windows-2016
  • macOS-latestmacOS-10.14

下面代碼指定虛擬機環境爲ubuntu-18.04

runs-on: ubuntu-18.04

(7)jobs.<job_id>.steps

steps字段指定每個 Job 的運行步驟,可以包含一個或多個步驟。每個步驟都可以指定以下三個字段。

  • jobs.<job_id>.steps.name:步驟名稱。
  • jobs.<job_id>.steps.run:該步驟運行的命令或者 action。
  • jobs.<job_id>.steps.env:該步驟所需的環境變量。

下面是一個完整的 workflow 文件的範例。

name: Greeting from Mona
on: push

jobs:
  my-job:
    name: My Job
    runs-on: ubuntu-latest
    steps:
    - name: Print a greeting
      env:
        MY_VAR: Hi there! My name is
        FIRST_NAME: Mona
        MIDDLE_NAME: The
        LAST_NAME: Octocat
      run: |
        echo $MY_VAR $FIRST_NAME $MIDDLE_NAME $LAST_NAME.

上面代碼中,steps字段只包括一個步驟。該步驟先注入四個環境變量,然後執行一條 Bash 命令。

GitHub Actions的使用(How)

以我的Vue項目爲例來說明GitHub Actions的基本使用。

  1. 我們在項目的頂部欄看到actions的一項;
  1. 創建workflow文件;

我們在項目倉庫的目錄下創建文件,存放的位置在.github/workflows/nodejs.yml

name: nodejs
on:
  push:
    branches:
      - master
jobs:
  build-and-deploy:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2
    - uses: actions/setup-node@v2
      with:
        node-version: '12'
    - run: npm install
    - run: npm run-script build
    - name: Deploy to GitHub Pages
      uses: JamesIves/[email protected]
      with:
        ACCESS_TOKEN: ${{ secrets.ACCESS_TOKEN }}
        BRANCH: gh-pages
        FOLDER: dist
  1. 保存文件並推送到GitHub;

  2. 等待workflow運行結束,訪問GitHub Pages,會看到結果。

參考(Where)

個人收穫及總結(With)

今天的文章爲大家介紹瞭如何利用GitHub Actions爲自己的項目創建CI服務,可以讓我們隨時構建我們的項目,把項目的運行環境、測試和發佈一體化,也能節省我們的時間,當然我們也可以使用Docker來創建測試鏡像,測試運行我們的項目,讓我們一起持續提升我們的技術,並做更有價值的事情。若是我的文章對你有所啓發,那將是我莫大的榮幸。希望和您一起精進,成爲更好的自己。

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章