Automating GitHub Blog Deployment#

1
# Workflow name
2
name: Deploy Hexo to GitHub Pages
3

4
# Triggers: run on push to the main branch
5
# `workflow_dispatch` lets you run it manually from the Actions page
6
on:
7
  push:
8
    branches:
9
      - main  # the branch that contains your Hexo source
10
  workflow_dispatch:
11

12
# Job configuration
13
jobs:
14
  build-and-deploy:
15
    # Runner
16
    runs-on: ubuntu-latest
17

18
    # Steps
19
    steps:
20
      # Step 1: Checkout repository
21
      - name: Checkout 🛎️
22
        uses: actions/checkout@v4
23
        with:
24
          # `submodules: 'recursive'` handles the common case where a Hexo theme is a submodule
25
          submodules: 'recursive'
26

27
      # Step 2: Set up Node.js
28
      - name: Set up Node.js 🟩
29
        uses: actions/setup-node@v4
30
        with:
31
          node-version: '24' # choose the Node.js version your project needs
32
          cache: 'npm' # cache npm dependencies to speed up future builds
33

34
      # Step 3: Install dependencies
35
      - name: Install Dependencies 📦
36
        run: npm install
37

38
      # Step 4: Generate static files
39
      - name: Generate Static Files ⚙️
40
        run: npx hexo generate # use `npx` to run the locally installed hexo-cli
41

42
      # Step 5: Deploy to GitHub Pages
43
      - name: Deploy to GitHub Pages 🚀
44
        uses: peaceiris/actions-gh-pages@v4
45
        with:
46
          # Personal Access Token stored in repo Secrets
47
          personal_token: ${{ secrets.HEXO_DEPLOY_TOKEN }}
48
          # Target repository in the form <owner>/<repo>
49
          # e.g. 'your-username/your-username.github.io'
50
          external_repository: springkill/springkill.github.io
51
          # Hexo output directory is `public` by default
52
          publish_dir: ./public
53
          # Target branch to push
54
          publish_branch: master # for user/org pages, usually `main` or `master`
55
          # Commit author
56
          user_name: 'springkill'
57
          user_email: 'zzz.love.study@gmail.com'
58
          # Commit message
59
          commit_message: "🚀 Deploy from Hexo source repo @ ${{ github.sha }}"
60
          # Clean the target branch so only the latest build remains
61
          keep_files: false