The GitHub Actions for automatic generate and deploy hexo-based blog.
Features:
-
Update source files after hexo g
-
Clean CloudFlare cached after deploy(Only support CloudFlare Token. For more you can try Cloudflare Purge Cache)
Before using this action, please config hexo env locally and install hexo-deployer-git plugin.
The official reference documentation of the plugin is https://hexo.io/docs/one-command-deployment#Git
e.g.
# Deployment
## Docs: https://hexo.io/docs/one-command-deployment#Git
deploy:
type: git
repo: [email protected]:yrpang/yrpang.github.io.git
branch: master-
Apply a DEPLOY_KEY for the repository of your GitHub Page
-
(Use Cloudflare Only)Apply a CLOUDFLARE_API_KEY
name: Hexo Build and Deploy
on: [push]
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v1
- name: Cache node modules
uses: actions/cache@v1
with:
path: node_modules
key: ${{runner.OS}}-${{hashFiles('**/package-lock.json')}}
- uses: yrpang/[email protected]
with:
deploykey: ${{secrets.DEPLOY_KEY}}
username: PUBLISHER_USER_NAME
email: PUBLISHER_EMAIL_ADDRESS| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| deploykey | secrets | Yes | The deploy key of your GitHub Page repository | |
| username | string | 'github-actions[bot]' | The publisher's username | |
| string | '41898282+github-actions[bot]@users.noreply.github.com' | The publisher's email address | ||
| if_keep_commit_history | boolean | false | Whether keep commit history | |
| github_page_repository | string | When if_keep_commit_history is ture and the GitHub Page repository (branch) is not <actor_username>.github.io, you need to set the other GitHub Page repository (branch) for get the commit history. |
||
| github_page_repository_branch | string | 'master' | When if_keep_commit_history is ture and the GitHub Page repository (branch) is not <actor_username>.github.io, you need to set the other GitHub Page repository (branch) for get the commit history. |
|
| if_update_files | boolean | false | Whether update the source file after generate | |
| github_token | secrets | Token for the repo. Can be passed in using ${{ secrets.GITHUB_TOKEN }} | ||
| branch | string | 'master' | The branch of the blog source code | |
| if_update_cloudflare | boolean | false | Whether update cloudflare | |
| cloudflare_zone | string | the cloudflare zone | ||
| cloudflare_token | secrets | Your cloudflare token |
The Dockerfile and associated scripts and documentation in this project are released under the MIT License.
GitHub are registered trademarks of GitHub, Inc. GitHub name used in this project are for identification purposes only. The project is not associated in any way with GitHub Inc. and is not an official solution of GitHub Inc. It was made available in order to facilitate the use of the site GitHub.