GitHub Actions for Hugo ️ Setup Hugo quickly and build your site fast. Hugo extended, Hugo Modules, Linux (Ubuntu), macOS, and Windows are supported. https://github.com/marketplace/actions/hugo-setup
Go to file
peaceiris e2b52b7b4d docs: update tag to v2.2.1 2019-09-25 12:44:14 +09:00
.github gha: remove paths 2019-09-23 14:35:33 +09:00
.vscode Feat: Support macOS and Windows, migrate JavaScript to TypeScript (#32) 2019-09-21 10:41:21 +09:00
__tests__ Feat: Support macOS and Windows, migrate JavaScript to TypeScript (#32) 2019-09-21 10:41:21 +09:00
images Release v0.57.0 (#8) 2019-08-15 20:26:15 +09:00
lib config: enhance tsconfig.json (#44) 2019-09-23 10:58:19 +09:00
node_modules Deps: update (#49) 2019-09-25 12:40:38 +09:00
src Refactor: enhance Hugo version dumping (#39) 2019-09-22 10:24:28 +09:00
.editorconfig Feat: Support macOS and Windows, migrate JavaScript to TypeScript (#32) 2019-09-21 10:41:21 +09:00
.eslintrc.json Feat: Support macOS and Windows, migrate JavaScript to TypeScript (#32) 2019-09-21 10:41:21 +09:00
.gitignore Migrate javascript action (#21) 2019-09-16 08:27:57 +09:00
.prettierrc.json Feat: Support macOS and Windows, migrate JavaScript to TypeScript (#32) 2019-09-21 10:41:21 +09:00
LICENSE add: action 2019-05-22 05:57:34 +09:00
README.md docs: update tag to v2.2.1 2019-09-25 12:44:14 +09:00
action.yml Refactor: directory structure (#31) 2019-09-18 07:32:17 +09:00
jest.config.js Feat: Support macOS and Windows, migrate JavaScript to TypeScript (#32) 2019-09-21 10:41:21 +09:00
package-lock.json Deps: update (#49) 2019-09-25 12:40:38 +09:00
package.json Deps: update (#49) 2019-09-25 12:40:38 +09:00
tsconfig.json config: enhance tsconfig.json (#44) 2019-09-23 10:58:19 +09:00

README.md

license release GitHub release date GitHub Actions status

GitHub Actions for Hugo

GitHub Actions for Hugo extended and Modules

We can run Hugo on a virtual machine of GitHub Actions by this Hugo action. Hugo extended version and Hugo Modules are supported.

From v2.0.0, this Hugo action migrated to a JavaScript (TypeScript) action. We no longer build or pull a Hugo docker image. Thanks to this change, we can complete this action less than 4 sec. (A docker base action was taking about 1 min or more execution time to build or pull.)

OS (runs-on) ubuntu-18.04 macOS-10.14 windows-2019
Support
Hugo type Hugo Extended Hugo Modules Latest Hugo
Support

Table of Contents

Getting started

Create your workflow

An example workflow .github/workflows/gh-pages.yml with GitHub Actions for deploying to GitHub Pages with Static Site Generators

peaceiris/actions-gh-pages - GitHub

peaceiris/actions-hugo latest version peaceiris/actions-gh-pages latest version

name: github pages

on:
  push:
    branches:
    - master

jobs:
  build-deploy:
    runs-on: ubuntu-18.04
    # runs-on: macOS-10.14
    # runs-on: windows-2019
    steps:
    - uses: actions/checkout@master
      # with:
      #   submodules: true

    - name: Setup Hugo
      uses: peaceiris/actions-hugo@v2.2.1
      with:
        hugo-version: '0.58.3'

    - name: Build
      run: hugo --gc --minify --cleanDestinationDir

    - name: Deploy
      uses: peaceiris/actions-gh-pages@v2.3.2
      env:
        ACTIONS_DEPLOY_KEY: ${{ secrets.ACTIONS_DEPLOY_KEY }}
        PUBLISH_BRANCH: gh-pages
        PUBLISH_DIR: ./public

Options

Use Hugo extended

Set extended: true to use a Hugo extended version.

- name: Setup Hugo
  uses: peaceiris/actions-hugo@v2.2.1
  with:
    hugo-version: '0.58.3'
    extended: true

Use the latest version of Hugo

Set hugo-version: 'latest' to use the latest version of Hugo.

- name: Setup Hugo
  uses: peaceiris/actions-hugo@v2.2.1
  with:
    hugo-version: 'latest'

This action fetches the latest version of Hugo by hugo | Homebrew Formulae

License

About the author