普通文組 2.5

使用GitHub Actions自動產生sitemap.xml

總結

使用 GitHub Actions 執行腳本，在每次透過git push更新網頁內容後自動產生 sitemap.xml

版本與環境

hexo: 5.3.0
hexo-cli: 4.2.0
os: Windows_NT 10.0.18363 win32 x64

過程記錄

  1. 在 GitHub repository 根目錄中建立資料夾.github/workflows，並在其中建立.yml格式的檔案來存放腳本
  2. 腳本內容如下：
name: Generate xml sitemap
# name會出現在Action標籤點開後，左側workflows的列表中


on:
  push:
    branches:
      - main
      # git push到main分支的時候，啟動以下腳本


jobs:
  sitemap_job:
    runs-on: ubuntu-latest
    name: Generate a sitemap
    steps:
      - name: Checkout the repo
        uses: actions/checkout@v2
        with:
          fetch-depth: 0
      - name: Generate new sitemap
        id: sitemap
        uses: cicirello/generate-sitemap@v1.6.1
        with:
          base-url-path: https://tzynwang.github.io/action-practice/
          # 參考cicirello/generate-sitemap的文件，將base-url-path的值設定為要產生sitemap的URL
      - name: Push sitemap to repository
        # 根據cicirello/generate-sitemap文件的說明，使用者需另找方法處理透過腳本產生的sitemap.xml
        # 故追加一段git腳本內容，把方才在GitHub Actions VM產生出來的sitemap透過git push放到repository中
        run: |
          git config --global user.name "tzyn (GitHub Actions sitemap gen)"
          git config --global user.email "tzyn.wang@gmail.com"
          git add sitemap.xml
          git commit -m "add sitemap.xml"
          git push
  1. 在本機執行git push將 commit 內容推到 GitHub 上
  2. 進入 repository 的 Actions 標籤，確認腳本有在執行
  3. 執行完成，確認 sitemap.xml 也有被加到 repository 中
  4. 在本機執行git pull將新產生的 sitemap.xml 拉本機資料夾

參考文件