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 1bb54b05c8 chore(release): 2.4.3 2020-01-24 13:37:14 +09:00
.dependabot chore: Change update_schedule from weekly to daily 2020-01-24 06:37:05 +09:00
.github style: remove extra whitespace [skip ci] 2020-01-24 00:20:16 +09:00
.vscode Feat: Support macOS and Windows, migrate JavaScript to TypeScript (#32) 2019-09-21 10:41:21 +09:00
__tests__ test: Add fail to fetch latest due to 404 (#137) 2020-01-21 01:35:00 +09:00
images [ImgBot] Optimize images (#56) 2019-10-08 14:01:01 +09:00
lib chore(release): Add build assets 2020-01-24 13:37:14 +09:00
src test: Add fail to fetch latest due to 404 (#137) 2020-01-21 01:35:00 +09:00
.dockerignore test: Add Docker container for testing [skip ci] 2020-01-18 01:10:09 +09:00
.editorconfig Feat: Support macOS and Windows, migrate JavaScript to TypeScript (#32) 2019-09-21 10:41:21 +09:00
.envrc chore: delete line 2019-10-09 11:49:24 +09:00
.eslintrc.json test: Add integration testing (#131) 2020-01-18 10:29:06 +09:00
.gitignore chore: Add .DS_Store [skip ci] 2020-01-18 01:12:59 +09:00
.nvmrc deps: upgrade node v12.14.1 (#119) 2020-01-10 10:20:50 +09:00
.prettierrc.json Feat: Support macOS and Windows, migrate JavaScript to TypeScript (#32) 2019-09-21 10:41:21 +09:00
CHANGELOG.md chore(release): 2.4.3 2020-01-24 13:37:14 +09:00
LICENSE chore: Update LICENSE year 2020-01-16 17:42:37 +09:00
Makefile test: Add Docker container for testing [skip ci] 2020-01-18 01:10:09 +09:00
README.md docs: Add Codecov badge 2020-01-21 01:08:43 +09:00
action.yml github: Update action meta 2019-10-29 10:03:36 +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 chore(release): 2.4.3 2020-01-24 13:37:14 +09:00
package.json chore(release): 2.4.3 2020-01-24 13:37:14 +09:00
release.sh ci: Add [skip ci] 2020-01-18 01:40:52 +09:00
tsconfig.json test: Add integration testing (#131) 2020-01-18 10:29:06 +09:00

README.md

license release GitHub release date GitHub Actions status CodeFactor codecov

GitHub Actions for Hugo

GitHub Actions for Hugo

This Hugo Setup Action can install Hugo to a virtual machine of GitHub Actions. Hugo extended version, Hugo Modules, Linux (Ubuntu), macOS, and Windows are supported.

From v2, this Hugo Setup Action has 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 in less than a few seconds. (A docker base action was taking about 1 min or more execution time to build and pull a docker image.)

OS (runs-on) ubuntu-18.04 macos-latest 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 GitHub Pages

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
    steps:
      - uses: actions/checkout@v1
        # with:
        #   submodules: true

      - name: Setup Hugo
        uses: peaceiris/actions-hugo@v2
        with:
          hugo-version: '0.62.2'
          # extended: true

      - name: Build
        run: hugo --minify

      - name: Deploy
        uses: peaceiris/actions-gh-pages@v2
        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
  with:
    hugo-version: '0.62.2'
    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
  with:
    hugo-version: 'latest'

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

Tips

Read Hugo version from file

How to sync a Hugo version between a Docker Compose and a GitHub Actions workflow via .env file.

Write a HUGO_VERSION to the .env file like the following and push it to a remote branch.

HUGO_VERSION=0.62.2

Next, add a step to read a Hugo version from the .env file.

    - name: Read .env
      id: hugo-version
      run: |
        . ./.env
        echo "::set-output name=HUGO_VERSION::${HUGO_VERSION}"        

    - name: Setup Hugo
      uses: peaceiris/actions-hugo@v2
      with:
        hugo-version: '${{ steps.hugo-version.outputs.HUGO_VERSION }}'
        extended: true

Here is a docker-compose.yml example.

version: '3'

services:
  hugo:
    container_name: hugo
    image: "peaceiris/hugo:v${HUGO_VERSION}"
    # image: peaceiris/hugo:v${HUGO_VERSION}-mod  # Hugo Modules
    ports:
      - 1313:1313
    volumes:
      - ${PWD}:/src
    command:
      - server
      - --bind=0.0.0.0
      - --buildDrafts

The alpine base Hugo Docker image is provided on the following repository.

peaceiris/hugo-extended-docker: Hugo alpine base Docker image (Hugo extended and Hugo Modules)

CHANGELOG

License

About Maintainer

Maintainer Notes

Run npm and git commit commands on a container.

On Host

# Docker
make build
make run
make run cmd="env"
make test
make commit msg="chore: Add Makefile"

# Release
./release.sh