Skip to content

🚀 GitHub action for deploying a Hexo project to GitHub pages. 使用GitHub Actions自动化构建部署Hexo博客

License

Notifications You must be signed in to change notification settings

h4m5t/hexo-deploy-github-pages-action

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

27 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Hexo Deploy GitHub Pages Action

This GitHub action for building and deploying Hexo project to GitHub pages.

使用GitHub Actions自动化构建部署Hexo博客,具体请看:

https://h4m5t.top/2022/12/30/hello-hexo/

Getting Started

You can view an example of this below.

name: Hexo Deploy GitHub Pages
on:
  push:
    branches:
      - master
jobs:
  build-and-deploy:
    runs-on: ubuntu-latest
    
    steps:
    - name: Checkout
      uses: actions/checkout@v3
      with:
        fetch-depth: 0

    - name: Build and Deploy
      uses: theme-keep/hexo-deploy-github-pages-action@master
      env:
        # Your GitHub Token
        PERSONAL_TOKEN: ${{ secrets.GITHUB_TOKEN }}

        # The repository the action should deploy to
        PUBLISH_REPOSITORY: theme-keep/site

Configuration item

The env portion of the workflow must be configured before the action will work. You can add these in the env section found in the examples above. Any secrets must be referenced using the bracket syntax and stored in the GitHub repositories Settings / Secrets and variables / Actions menu. You can learn more about setting environment variables with GitHub actions here.

Below you'll find a description of what each option does.

Key Value Information Type Default Required
PERSONAL_TOKEN Depending on the repository permissions you need to provide the action with a GitHub Personal Access Token in order to deploy. You can learn more about how to generate one here. This should be stored as a secret. secrets Yes
PUBLISH_REPOSITORY The repository the action should deploy to. for example theme-keep/site env Yes
BRANCH The branch the action should deploy to. for example master env gh-pages No
PUBLISH_DIR The folder the action should deploy. for example ./public env ./public No
CNAME The domain name of your GitHub Page specified in a CNAME env No

About

🚀 GitHub action for deploying a Hexo project to GitHub pages. 使用GitHub Actions自动化构建部署Hexo博客

Resources

License

Stars

Watchers

Forks

Languages

  • Shell 83.7%
  • Dockerfile 16.3%