2019-05-21 20:57:34 +00:00
[![license ](https://img.shields.io/github/license/peaceiris/actions-hugo.svg )](https://github.com/peaceiris/actions-hugo/blob/master/LICENSE)
[![release ](https://img.shields.io/github/release/peaceiris/actions-hugo.svg )](https://github.com/peaceiris/actions-hugo/releases/latest)
[![GitHub release date ](https://img.shields.io/github/release-date/peaceiris/actions-hugo.svg )](https://github.com/peaceiris/actions-hugo/releases)
2019-10-17 07:31:56 +00:00
![GitHub Actions status ](https://github.com/peaceiris/actions-hugo/workflows/Test/badge.svg )
2019-11-13 03:58:32 +00:00
[![CodeFactor ](https://www.codefactor.io/repository/github/peaceiris/actions-hugo/badge )](https://www.codefactor.io/repository/github/peaceiris/actions-hugo)
2019-05-21 20:57:34 +00:00
2019-09-15 23:27:57 +00:00
< img width = "400" alt = "GitHub Actions for Hugo" src = "./images/ogp.svg" >
2019-05-21 20:57:34 +00:00
2019-11-22 03:12:20 +00:00
## GitHub Actions for Hugo
2019-05-21 20:57:34 +00:00
- [gohugoio/hugo: The world’ s fastest framework for building websites. ](https://github.com/gohugoio/hugo )
2019-11-22 03:12:20 +00:00
We can run **Hugo** on a virtual machine of **GitHub Actions** by this Hugo action. **Hugo extended** version and **Hugo Modules** are supported.
2019-09-17 11:39:59 +00:00
2019-11-28 11:47:38 +00:00
From `v2` , 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.)
2019-09-21 01:41:21 +00:00
2019-11-06 23:21:32 +00:00
| OS (runs-on) | ubuntu-18.04 | macos-latest | windows-2019 |
2019-09-21 01:41:21 +00:00
|---|:---:|:---:|:---:|
| Support | ✅️ | ✅️ | ✅️ |
| Hugo type | Hugo Extended | Hugo Modules | Latest Hugo |
|---|:---:|:---:|:---:|
| Support | ✅️ | ✅️ | ✅️ |
2019-09-17 11:39:59 +00:00
2019-11-22 03:12:20 +00:00
## Table of Contents
2019-09-22 00:43:11 +00:00
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE - RUN doctoc TO UPDATE -->
2019-11-22 03:12:20 +00:00
2019-09-22 00:43:11 +00:00
- [Getting started ](#getting-started )
- [⭐️ Create your workflow ](#%EF%B8%8F-create-your-workflow )
- [Options ](#options )
- [⭐️ Use Hugo extended ](#%EF%B8%8F-use-hugo-extended )
- [⭐️ Use the latest version of Hugo ](#%EF%B8%8F-use-the-latest-version-of-hugo )
2019-11-22 03:12:20 +00:00
- [Tips ](#tips )
2019-11-22 03:15:00 +00:00
- [⭐️ Read Hugo version from file ](#%EF%B8%8F-read-hugo-version-from-file )
2019-09-22 00:43:11 +00:00
- [License ](#license )
- [About the author ](#about-the-author )
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
2019-05-21 20:57:34 +00:00
## Getting started
2019-09-22 00:43:11 +00:00
### ⭐️ Create your workflow
2019-05-21 20:57:34 +00:00
2019-10-19 07:52:57 +00:00
An example workflow `.github/workflows/gh-pages.yml` with [GitHub Actions for GitHub Pages]
2019-05-21 22:18:16 +00:00
2019-10-19 07:52:57 +00:00
[GitHub Actions for GitHub Pages]: https://github.com/peaceiris/actions-gh-pages
2019-05-21 22:18:16 +00:00
2019-09-09 16:25:39 +00:00
[![peaceiris/actions-gh-pages - GitHub ](https://gh-card.dev/repos/peaceiris/actions-gh-pages.svg?fullname )](https://github.com/peaceiris/actions-gh-pages)
2019-05-26 21:22:45 +00:00
![peaceiris/actions-hugo latest version ](https://img.shields.io/github/release/peaceiris/actions-hugo.svg?label=peaceiris%2Factions-hugo )
![peaceiris/actions-gh-pages latest version ](https://img.shields.io/github/release/peaceiris/actions-gh-pages.svg?label=peaceiris%2Factions-gh-pages )
2019-08-15 11:26:15 +00:00
```yaml
2019-08-21 20:03:19 +00:00
name: github pages
2019-08-15 11:26:15 +00:00
on:
push:
branches:
- master
jobs:
build-deploy:
2019-08-21 17:54:38 +00:00
runs-on: ubuntu-18.04
2019-08-15 11:26:15 +00:00
steps:
2019-11-30 18:56:39 +00:00
- uses: actions/checkout@v1
2019-09-23 22:31:06 +00:00
# with:
# submodules: true
2019-09-04 16:50:24 +00:00
2019-09-15 23:27:57 +00:00
- name: Setup Hugo
2019-11-28 11:47:38 +00:00
uses: peaceiris/actions-hugo@v2
2019-08-15 11:26:15 +00:00
with:
2019-11-22 03:12:20 +00:00
hugo-version: '0.59.1'
2019-10-06 15:11:15 +00:00
# extended: true
2019-09-04 16:50:24 +00:00
2019-09-15 23:27:57 +00:00
- name: Build
2019-10-24 12:51:13 +00:00
run: hugo --minify
2019-09-15 23:27:57 +00:00
- name: Deploy
2019-12-07 22:57:55 +00:00
uses: peaceiris/actions-gh-pages@v2
2019-08-15 11:26:15 +00:00
env:
2019-09-05 18:09:36 +00:00
ACTIONS_DEPLOY_KEY: ${{ secrets.ACTIONS_DEPLOY_KEY }}
2019-08-15 11:26:15 +00:00
PUBLISH_BRANCH: gh-pages
PUBLISH_DIR: ./public
2019-05-21 20:57:34 +00:00
```
2019-11-22 03:19:08 +00:00
< div align = "right" >
< a href = "#table-of-contents" > Back to TOC ☝️< / a >
< / div >
2019-05-21 20:57:34 +00:00
2019-09-15 23:27:57 +00:00
## Options
2019-09-22 00:43:11 +00:00
### ⭐️ Use Hugo extended
2019-09-15 23:27:57 +00:00
2019-09-22 00:37:17 +00:00
Set `extended: true` to use a Hugo extended version.
2019-09-15 23:27:57 +00:00
```yaml
- name: Setup Hugo
2019-11-28 11:47:38 +00:00
uses: peaceiris/actions-hugo@v2
2019-09-15 23:27:57 +00:00
with:
2019-11-22 03:12:20 +00:00
hugo-version: '0.59.1'
2019-09-15 23:27:57 +00:00
extended: true
```
2019-09-22 00:43:11 +00:00
### ⭐️ Use the latest version of Hugo
2019-09-15 23:27:57 +00:00
2019-09-22 00:37:17 +00:00
Set `hugo-version: 'latest'` to use the latest version of Hugo.
2019-09-15 23:27:57 +00:00
```yaml
- name: Setup Hugo
2019-11-28 11:47:38 +00:00
uses: peaceiris/actions-hugo@v2
2019-09-15 23:27:57 +00:00
with:
hugo-version: 'latest'
```
2019-09-17 19:11:47 +00:00
This action fetches the latest version of Hugo by [hugo | Homebrew Formulae ](https://formulae.brew.sh/formula/hugo )
2019-09-15 23:27:57 +00:00
2019-11-22 03:19:08 +00:00
< div align = "right" >
< a href = "#table-of-contents" > Back to TOC ☝️< / a >
< / div >
2019-09-15 23:27:57 +00:00
2019-11-22 03:12:20 +00:00
## Tips
2019-11-22 03:15:00 +00:00
### ⭐️ Read Hugo version from file
2019-11-22 03:12:20 +00:00
2019-11-28 11:43:56 +00:00
How to sync a Hugo version between a Docker Compose and a GitHub Actions workflow via `.env` file.
2019-11-22 03:12:20 +00:00
Write a `HUGO_VERSION` to the `.env` file like the following and push it to a remote branch.
```sh
HUGO_VERSION=0.59.1
```
Next, add a step to read a Hugo version from the `.env` file.
```yaml
- name: Read .env
id: hugo-version
run: |
. ./.env
2019-11-22 03:17:04 +00:00
echo "::set-output name=HUGO_VERSION::${HUGO_VERSION}"
2019-11-22 03:12:20 +00:00
- name: Setup Hugo
2019-11-28 11:47:38 +00:00
uses: peaceiris/actions-hugo@v2
2019-11-22 03:12:20 +00:00
with:
hugo-version: '${{ steps.hugo-version.outputs.HUGO_VERSION }}'
extended: true
```
Here is a `docker-compose.yml` example.
```yaml
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
```
2019-12-17 22:01:35 +00:00
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)](https://github.com/peaceiris/hugo-extended-docker)
2019-11-22 03:12:20 +00:00
2019-05-21 20:57:34 +00:00
## License
2019-08-15 11:26:15 +00:00
- [MIT License - peaceiris/actions-hugo]
2019-05-21 20:57:34 +00:00
[MIT License - peaceiris/actions-hugo]: https://github.com/peaceiris/actions-hugo/blob/master/LICENSE
2019-05-22 12:01:05 +00:00
## About the author
- [peaceiris's homepage ](https://peaceiris.com/ )
2019-11-22 03:19:08 +00:00
< div align = "right" >
< a href = "#table-of-contents" > Back to TOC ☝️< / a >
< / div >