date
Nov 13, 2020
slug
auto-deploy-hugo-github-page
status
Published
tags
webdev
github
workflow
summary
บอกไว้ก่อนเลยว่าวิธีการนี้ได้มาจากชาวญี่ปุ่นท่านนึง ด้วยความที่ไปหาข้อมูลในเว็บนอกแล้วโซนฝั่งเขาแนะนำอีกวิธีหนึ่งซึ่งมันกึ่งๆอัตโนมัติ
type
Post
category
tech
github.io โฮสต์เว็บเพจได้ฟรีเหมือนกัน แต่ส่วนใหญ่แล้วจะง่ายต่อ Static web ประเภท Jekyll มากกว่าตัวอื่น เพราะมันสามารถ Deploy ได้จากตัวเองเลย ในขณะที่คู่แข่งอย่าง Hugo นั้นต้องอาศัยกาารเล่นท่ายากสักหน่อย แต่ก็ใช่ว่าจะ auto deploy ไม่ได้นะ
บอกไว้ก่อนเลยว่าวิธีการนี้ได้มาจากชาวญี่ปุ่นท่านนึง(ref. ด้านล่าง) ด้วยความที่ไปหาข้อมูลในเว็บนอกแล้วโซนฝั่งเขาแนะนำอีกวิธีหนึ่งซึ่งมันกึ่งๆอัตโนมัติ แต่มันก็ต้องไปรันคำสั่งเองอีกที ส่วนตัวคิดว่าเอาเวลาที่รันคำสั่งนั้น ไปกด push repo ตัวที่เป็น output หน้าเว็บมันก็เหมือนกัน เลยไม่ซื้อวิธีดังกล่าว
ไอเดียและสิ่งที่ต้องมีหลักๆ คือ
- จำเป็นต้องมี ssh key ของ github ทั้ง private กับ public เลย (หรือใครจะใช้ personal access token ก็ได้ ส่วนตัวไม่ถนัดเลยเลือก SSH key แทน)
- แยก repository กันระหว่างตัว Hugo กับ Repository ที่แสดงผลเว็บ (ส่วนของธีมจะแยกหรือไม่ก็ได้)
- อาศัย action ของ github
ก่อนอื่นเลย สร้าง repo แยกกันให้หมดเลย ตามที่เขียนไว้ด้านบน โดยในที่นี้จะสร้างไว้เป็น 2 อันแยกกัน hugo_files เก็บไฟล์ของ Hugo ทั้งหมด, (username).github.io เอาไว้ให้ hugo เก็บไฟล์เว็บเวลาสั่งรัน (นึกถึงตอนใช้คำสั่ง
hugo
แล้วมันสร้างโฟลเดอร์ public ที่มีหน้าเว็บมาให้ หลักการเหมือนกัน เพียงแต่เราจะให้มันมาสร้างที่ Repo ที่ไว้เก็บเว็บเพจแทน อย่างงนะ)1. สร้าง ssh key
- ทำการ generate key public และ privat ด้วยคำสั่ง
ssh-keygen -t rsa -b 4096 -C "$(git config user.email)" -f gh-pages -N ""
จะได้ไฟล์ 2 ตัวโผล่มา คือ
gh-pages
และ gh-pages.pub
(สั่งรัน bash จากที่ไหนไฟล์จะเก็บอยู่ที่นั่น)- ไปที่ Repo
hugo_files
(อย่างอื่นก็ได้แค่จำได้ว่าเก็บไฟล์ hugo ก็พอ) และไปที่setting > secret > New repository secret
โดยตั้งชื่อ Secret ที่สร้างขึ้นว่าACTIONS_DEPLOY_KEY
และเปิดไฟล์gh-page
ที่ไม่มี .pub ด้วยโปรแกรม text editor อันไหนก็ได้ notepad ก็ได้ และทำการ copy เนื้อหาข้างในทั้งหมด ใส่ลงไปในส่วน Value
- ไปที่ repo ชื่อ
(username).github.io
ไปที่setting > deploy keys > add deploy key
ในส่วน title ใส่ชื่ออะไรก็ได้ เปิดไฟล์gh-pages.pub
ในส่วนนี้จะเป็น public key ทำการ copy ทั้งหมด มาใส่ในส่วนkey
อย่าลืมติ๊กช่องAllow write access
2. สร้าง Directory ไว้รัน Action script
สร้าง directory ใน repo
hugo_files
จะใช้วิธีสร้างบน git หรือสร้างบน local แล้ว push ก็ได้ โดย directory ที่ต้องการคือ .github/workflows
และในโฟลเดอร์ Workflows นี้ให้ทำการสร้างไฟล์ใหม่ขึ้นมา 1 ไฟล์ ชื่อไฟล์อะไรก็ได้.yml
3. ทำการ config เพื่อใช้ action ของ github
ในไฟล์
ชื่อไฟล์อะไรก็ได้.yml
ที่สร้างขึ้นเมื่อสักครู่ ให้ทำการใส่ action script ดังนี้name: GitHub Pages on: push: branches: - master jobs: build-deploy: runs-on: ubuntu-18.04 steps: - name: Fix up git URLs run: echo -e '[url "https://github.com/"]\n insteadOf = "[email protected]:"' >> ~/.gitconfig - name: Checkout uses: actions/[email protected] with: submodules: true - name: Hugo setup uses: peaceiris/[email protected] - name: Build run: hugo --gc --minify --cleanDestinationDir env: TZ: 'Asia/Bangkok' - name: Deploy uses: peaceiris/actions-gh-pages@v2 env: ACTIONS_DEPLOY_KEY: ${{ secrets.ACTIONS_DEPLOY_KEY }} # uncomment ข้างล่างในกรณีใช้ personal access token #PERSONAL_TOKEN: ${{ secrets.MY_GITHUB_ACCESS_TOKEN }} EXTERNAL_REPOSITORY: pickyzz/pickyzz.github.io PUBLISH_BRANCH: main PUBLISH_DIR: ./public TZ: 'Asia/Bangkok'
ผลที่ได้
เมื่อเราทำการ push อัพเดทไปยัง repo ที่ใช้เก็บไฟล์ hugo ที่ยังไม่ได้ compile หน้าเว็บ ทันทีที่พบ new commit, ตัว script จะรันคำสั่ง hugo ไปยัง repo ที่ใส่ public key ไว้ทันที สามารถตรวจสอบผลได้ที่ Action ของ repo เก็บ hugo ได้เลย
reference
Last edited : Apr 11, 2022
Relate Posts
Copyright
- Author:Parinya T.
- URL:https://pickyzz.dev/article/auto-deploy-hugo-github-page
- All articles in this blog, except for special statements, adopt BY-NC-SA agreement. Please indicate the source!
Tags:
webdev
github
workflow