Travis CI 自動 Jekyll 專案部屬 Github Pages 完整範例

了解如何「[Github] 在github.io建立免費的網站」，搭配使用 Jekyll 可以讓部落格或靜態網站的撰寫更加便利，完成內容的更新後，可以透過指令編譯 _site 的目錄，轉成瀏覽器可讀的格式，最後將目錄上傳到web server。

這些流程可以使用 Travis CI 自動化，當 github repo 收到新的 Request時，自動編譯上傳到 github.io。 若未有 Jekyll 專案，請先參考「靜態網頁部落格工具 Ruby + Jekyll 安裝教學」，建立一個新專案。

一、新增編譯腳本

mkdir script
vim script/cibuild

script/cibuild 內容如下(參考檔案):

#!/usr/bin/env bash
set -e # halt script on error

JEKYLL_ENV=production bundle exec jekyll build
# bundle exec htmlproofer ./_site

二、新增 Travis CI 設定檔

.travis.yml 內容如下(參考檔案):

language: ruby
rvm:
- 2.6
script: ./script/cibuild
before_script:
- chmod +x ./script/cibuild
deploy:
  provider: pages
  skip_cleanup: true
  github_token: $GITHUB_TOKEN
  repo: chenuin/chenuin.github.io
  local_dir: ./_site
  target_branch: master
  on:
    branch: master

TOKEN 設定(參考)

1. 開啟頁面 https://github.com/settings/tokens/new
2. 填寫備註(可以自行決定)，並選擇 public_repo
3. 送出

將畫面顯示的 token 複製保存好，到 Travis CI 設定環境變數，新增一個參數 GITHUB_TOKEN，內容就是剛剛複製的這一串字串 。 

※操作畫面可參考「Travis CI 快速部屬 Jekyll + Asciidoctor」的第四步驟 - 新增 github token 。

三、上傳

git add .
git commit -m 'init commit'
git push origin master

專案連結： 

https://github.com/chenuin/myblog 

https://chenuin.github.io/

Travis CI 快速部屬 Jekyll + Asciidoctor

Github.io可以支援markdown，若要 asciidoctor 進行編輯，可以透過 Jeykll 在 github 上提供的專案，免去複雜的設定，快速完成布署。內容是參考 README，作業系統為 Ubuntu，統整成下面的步驟：

一、安裝

靜態網頁部落格工具 Ruby + Jekyll 安裝教學

Asciidoctor 安裝及入門範例

二、下載原始碼

請先 fork jekyll-asciidoc-quickstart ，再下載專案 jekyll-asciidoc-quickstart

git clone https://github.com/[github-account]/jekyll-asciidoc-quickstart

三、設定 Travis CI

Travic CI 先後推出 travis-ci.org、travis-ci.com，兩者的介面很相近，以下都是使用 travis-ci.com 進行操作。

請先到 github settings，將這個專案同步到 Travis CI上。 

 

四、新增 github token

1. 開啟頁面 https://github.com/settings/tokens/new
2. 填寫備註(可以自行決定)，並選擇 public_repo
3. 送出

請將畫面顯示的 token 複製保存好，一旦離開此頁面，就不會再看到這串 token。若遺失 token，只能再另外產生一組新的。

 

完成後，到 Travis CI 設定環境變數(Environment Variables) 

Name:  GH_TOKEN

Value: [token]  (剛剛在github複製的字串)

按下 Add 完成設定。 

 (連結參考 https://travis-ci.com/github/[github-account]/jekyll-asciidoc-quickstart/settings)

  

直接在網頁上新增更方便，原始文件提供的方法是安裝 travis 的套件，用指令加密 token 後，直接新增到 .travis.yml，也可以參考試試看。

五、編輯 .travis.yml

原始專案設定 rvm 版本已經太舊了，請把 2.2 改成 2.6，否則 CI 執行會失敗。

# .travis.yml
rvm:
  - 2.6

完整檔案請看: .travis.yml

git add .travis.yml
git commit -m 'update rvm version'

六、上傳

git push -u origin master

可以到 Travis CI 上確認執行結果，若正確設定的話，將自動把 master 的內容編譯後，自動上傳到分支 gh-pages 。 

開啟頁面 https://[github-account].github.io/jekyll-asciidoc-quickstart/ ，順利看到畫面就完成了。

完整專案範例

https://github.com/chenuin/jekyll-asciidoc-quickstart

https://chenuin.github.io/jekyll-asciidoc-quickstart/