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-09-15 23:45:47 +00:00
[![GitHub Actions status ](https://github.com/peaceiris/actions-hugo/workflows/Test/badge.svg )](https://github.com/peaceiris/actions-hugo/actions)
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-07-27 10:29:29 +00:00
## GitHub Actions for Hugo extended and Modules
2019-05-21 20:57:34 +00:00
- [gohugoio/hugo: The world’ s fastest framework for building websites. ](https://github.com/gohugoio/hugo )
2019-09-17 11:39:59 +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-22 06:45:20 +00:00
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.)
2019-09-21 01:41:21 +00:00
| OS (runs-on) | ubuntu-18.04 | macOS-10.14 | windows-2019 |
|---|:---:|:---:|:---:|
| Support | ✅️ | ✅️ | ✅️ |
| Hugo type | Hugo Extended | Hugo Modules | Latest Hugo |
|---|:---:|:---:|:---:|
| Support | ✅️ | ✅️ | ✅️ |
2019-09-17 11:39:59 +00:00
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 -->
*Table of Contents*
- [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 )
- [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-09-17 19:18:10 +00:00
An example workflow `.github/workflows/gh-pages.yml` with [GitHub Actions for deploying to GitHub Pages with Static Site Generators]
2019-05-21 22:18:16 +00:00
[GitHub Actions for deploying to GitHub Pages with Static Site Generators]: https://github.com/peaceiris/actions-gh-pages
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-09-21 01:41:21 +00:00
# runs-on: macOS-10.14
# runs-on: windows-2019
2019-08-15 11:26:15 +00:00
steps:
- uses: actions/checkout@master
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-09-25 03:44:14 +00:00
uses: peaceiris/actions-hugo@v2.2.1
2019-08-15 11:26:15 +00:00
with:
2019-09-21 01:41:21 +00:00
hugo-version: '0.58.3'
2019-09-04 16:50:24 +00:00
2019-09-15 23:27:57 +00:00
- name: Build
run: hugo --gc --minify --cleanDestinationDir
- name: Deploy
2019-09-25 03:47:37 +00:00
uses: peaceiris/actions-gh-pages@v2.4.0
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-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-09-25 03:44:14 +00:00
uses: peaceiris/actions-hugo@v2.2.1
2019-09-15 23:27:57 +00:00
with:
2019-09-21 01:41:21 +00:00
hugo-version: '0.58.3'
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-09-25 03:44:14 +00:00
uses: peaceiris/actions-hugo@v2.2.1
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-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/ )