Giter Club home page Giter Club logo

hexo-deploy-github-pages-action's Introduction

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

hexo-deploy-github-pages-action's People

Contributors

derogab avatar griffithben avatar h4m5t avatar langu-xyz avatar xpoet avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.