Orgin from smallblack, and hacked by Jay9z for auto action of private blog. This GitHub action will handle the building and deploying process of hexo project.
You can view an example of this below.
name: Build and Deploy
on: [push]
jobs:
build-and-deploy:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@master
- name: Build and Deploy
uses: renzhaosy/hexo-deploy-action@master
env:
PERSONAL_TOKEN: ${{ secrets.GITHUB_TOKEN }}
PUBLISH_REPOSITORY: jay9z/jay9z.github.io # The repository the action should deploy to.
BRANCH: master # The branch the action should deploy to.
PUBLISH_DIR: ./public # The folder the action should deploy.
if you want to make the workflow only triggers on push events to specific branches, you can like this:
on:
push:
branches:
- master
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
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 | Required |
---|---|---|---|
PERSONAL_TOKEN |
Depending on the repository permissions you may 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 jay9z/jay9z.github.io |
env |
Yes |
BRANCH |
The branch the action should deploy to. for example master |
env |
Yes |
PUBLISH_DIR |
The folder the action should deploy. for example ./public |
env |
Yes |